Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.93 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.93 KB

EntraID Scanner

Welcome to the source code repo for the Entra ID Scanner. You can start browsing the source code by clicking on 'src' folder above. To learn more, go through the complete documentation here.

Steps to install the package:

Open Windows PowerShell ISE or Windows PowerShell terminal and run the following commands:

  1. Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
    [Optional] Set the execution policy to allow the installation of the module.

  2. Install-Module -Name PowerShellGet -RequiredVersion 2.2.5 -Scope CurrentUser -Repository PSGallery -AllowClobber
    [Optional] Most systems have an older version of PowerShellGet which is not trusted anymore by the repositories.

  3. Register-PSRepository -Name PoshTestGallery -SourceLocation https://www.poshtestgallery.com/api/v2/ -InstallationPolicy Trusted
    Registers a PowerShell repository.
    (Set the gallery name to PSGallery for the prod version and PoshTestGallery for dev version/bugbash purpose)

  4. Install latest version of the module from PoshTestGallery
    Install-module AzSKStaging.AAD -Repository PoshTestGallery -Force -AllowClobber -Scope CurrentUser
    (Prod version: Install-module AzSK.AAD -Repository PSGallery -Force -AllowClobber -Scope CurrentUser)

Running the scanner:

  1. ipmo AzSKStaging.AAD
    Import the package

  2. Get-AzSKAADSecurityStatusTenant -TenantId <yourTenantId> -IncludeDetailedResult #Tenant scan
    Tenant scan cmdlet

  3. Get-AzSKAADSecurityStatusUser -TenantId <yourTenantId> -IncludeDetailedResult -mo 10 #User owned objects scan
    User owned objects scan cmdlet

Contributing:

  1. Navigate to the cloned repository and run .\requirements.ps1.

  2. Copy debug.local-template.ps1 content to debug.local.ps1 and fill in the required values.