(Xojo Plugin) Azure Key Vault - List Matching Secrets

See more Secrets Examples

List secrets in the Azure Key Vault matching one or more wildcarded names for app, service, domain, and username.

Note: This example requires Chilkat v10.1.0 or later.

For more information, see https://cknotes.com/chilkat-secrets-class-added-in-version-10-1-0/

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// The bootstrap secret will contain the following information:

// Azure Tenant ID
// Azure Client ID
// Azure Client Secret

// See following examples for setting up a bootstrap secret in memory, 
// or in the local manager (Windows Credentials Manager or Apple Keychain)
// Setup Bootstrap Secret in Local Manager
// Setup Bootstrap Secret in Memory
Dim bootstrap As New Chilkat.Secrets

// Set the location of the bootstrap secret.
// Can be "local_manager" or "memory", depending on how you setup the bootstrap secret.
// ---------------------------------------------------------------------------------------------
// If your operating system is NOT Windows or MacOS/iOS, then change "local_manager" to "memory"
// You can also, if desired, use "memory" on Windows and MacOS/iOS if your bootstrap secret was previously setup in memory.
// ---------------------------------------------------------------------------------------------
bootstrap.Location = "local_manager"

// Specify the bootstrap secret to be used.
Dim bsId As New Chilkat.JsonObject
Dim success As Boolean
success = bsId.UpdateString("appName","azure_bs")
success = bsId.UpdateString("service","Example")
success = bsId.UpdateString("username","Joe")

// ----------------------------------------------------
Dim secrets As New Chilkat.Secrets

// Setup for the Azure Key Vault
secrets.Location = "azure_key_vault"
Dim success As Boolean
success = secrets.SetBootstrapSecret(bsId,bootstrap)
If (success = False) Then
    System.DebugLog(secrets.LastErrorText)
    Return
End If

// Set wildcarded or exact values for appName, service, domain, and username.
// Omit any members where anything is allowed to match, or alternatively specify "*" to match anything.
Dim jsonMatch As New Chilkat.JsonObject
success = jsonMatch.UpdateString("appName","Test*")
// The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
success = jsonMatch.UpdateString("service","*")
success = jsonMatch.UpdateString("domain","*")
success = jsonMatch.UpdateString("username","*")

// For Azure Key Vault, we also need to specify the name of the vault containing the secrets to be listed.
// Replace "kvChilkat" with the name of your key vault.
success = jsonMatch.UpdateString("vaultName","kvChilkat")

Dim results As New Chilkat.JsonObject
results.EmitCompact = False

success = secrets.ListSecrets(jsonMatch,results)
If (success = False) Then
    System.DebugLog(secrets.LastErrorText)
    Return
End If

System.DebugLog(results.Emit())

// Sample output:

// {
//   "secrets": [
//     {
//       "appName": "Test",
//       "service": "Something",
//       "domain": "Xyz",
//       "username": "Abc",
//       "azure_id": "https://kvchilkat.vault.azure.net/secrets/Test-Something-Xyz-Abc"
//     },
//     {
//       "appName": "Test2",
//       "service": "Custom",
//       "domain": "Ocean",
//       "username": "Starfish",
//       "azure_id": "https://kvchilkat.vault.azure.net/secrets/Test2-Custom-Ocean-Starfish"
//     }
//   ]
// }

// ---------------------------------------------------------------------------------------
// Here's sample code for parsing the JSON list of secrets.

Dim appName As String
Dim service As String
Dim domain As String
Dim username As String
Dim azure_id As String

Dim i As Int32
i = 0
Dim numSecrets As Int32
numSecrets = results.SizeOfArray("secrets")
While i < numSecrets
    results.I = i
    // Note: appName and domain are optional and may not exist in any given secret.
    appName = results.StringOf("secrets[i].appName")
    service = results.StringOf("secrets[i].service")
    domain = results.StringOf("secrets[i].domain")
    username = results.StringOf("secrets[i].username")
    // Informational field for the raw Azure secret name.
    azure_id = results.StringOf("secrets[i].azure_id")
    i = i + 1
Wend