microsoft / keyvaultscannerutility

This Utility can search any specified Key/Secret in all KeyVault present in your subscription. The search result than can be exported to an excel file and you can also update the secret directly from the utility UI.

Introduction

This Utility can search any specified Key/Secret in all KeyVault present in your subscription. The search result than can be exported to an excel file and you can also update the secret directly from the Utility UI.

• Light weight : PowerShell based utility.
• Secure : Runs on user context and doesn't collect any telemetry or logs.

Prerequisite

• Requires Powershell Core or Powershell 7 and above

  Install Powershell core 7.0

• Start Windows PowerShell with the "Run as administrator" option and Set Execution Policy

   PM> Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
   PM> Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope LocalMachine
   

• If Az Module is not already Installed, Install by running below command on Powershell core

   PM> Install-Module -Name Az -Force

• If Az.Keyvault Module is not already Installed, Install by running below command on Powershell core

   PM> Install-Module -Name Az.keyvault -Force -AllowClobber

• You should have access to the secrets in KeyVault

  Assign Access Policy Portal.

Steps

• Click on Run.vbs to launch the application

• Login to Azure from the screen.

• Once logged in enter Subscription ID, Secret/Key, Value to be searched & Keyvault Name and click Search

• Utility will start searching secret/key in the KeyVault and Result be displayed in the Result Box as shown

• Result can be Exported to CSV file and file will be saved on Desktop with the name scanresult.csv

• You can select what all keys in the result that needs to be updated with new value and pass the value to the textbox and click update )

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

keyvaultscannerutility's Issues

Utility seems to get stuck while searching for secret.

Describe the bug
I used the utility to search for a secret in one of our key vaults and it seems to get stuck or maybe processing something for a long time. Filing issue here for visibility in case this is happening with others. Not sure if this is related to me using SC-ALT account. Although, that shouldn't be an issue.

To Reproduce
Steps to reproduce the behavior:

1. Login to the utility with SC-ALT account
2. Choose the subscription of key vault on which you want to execute the search for this issue.
3. Select secret and enter the value of secret that exists in key vault.
4. Enter the name of the key vault and click search.

Expected behavior
The utility should show the name(s) of the secret where the value is stored.

Screenshots

Desktop (please complete the following information):

• OS:
  

• Powershell
  

Additional context
Add any other context about the problem here.