(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Bootstrap
oleobject loo_BsId
oleobject loo_Secrets
integer li_Success
oleobject loo_JsonMatch
oleobject loo_Results
string ls_AppName
string ls_Service
string ls_Domain
string ls_Username
string ls_Azure_id
integer i
integer li_NumSecrets

// 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
loo_Bootstrap = create oleobject
// Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
li_rc = loo_Bootstrap.ConnectToNewObject("Chilkat.Secrets")
if li_rc < 0 then
    destroy loo_Bootstrap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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.
// ---------------------------------------------------------------------------------------------
loo_Bootstrap.Location = "local_manager"

// Specify the bootstrap secret to be used.
loo_BsId = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_BsId.ConnectToNewObject("Chilkat.JsonObject")

loo_BsId.UpdateString("appName","azure_bs")
loo_BsId.UpdateString("service","Example")
loo_BsId.UpdateString("username","Joe")

// ----------------------------------------------------
loo_Secrets = create oleobject
// Use "Chilkat_9_5_0.Secrets" for versions of Chilkat < 10.0.0
li_rc = loo_Secrets.ConnectToNewObject("Chilkat.Secrets")

// Setup for the Azure Key Vault
loo_Secrets.Location = "azure_key_vault"
li_Success = loo_Secrets.SetBootstrapSecret(loo_BsId,loo_Bootstrap)
if li_Success = 0 then
    Write-Debug loo_Secrets.LastErrorText
    destroy loo_Bootstrap
    destroy loo_BsId
    destroy loo_Secrets
    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.
loo_JsonMatch = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonMatch.ConnectToNewObject("Chilkat.JsonObject")

loo_JsonMatch.UpdateString("appName","Test*")
// The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
loo_JsonMatch.UpdateString("service","*")
loo_JsonMatch.UpdateString("domain","*")
loo_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.
loo_JsonMatch.UpdateString("vaultName","kvChilkat")

loo_Results = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Results.ConnectToNewObject("Chilkat.JsonObject")

loo_Results.EmitCompact = 0

li_Success = loo_Secrets.ListSecrets(loo_JsonMatch,loo_Results)
if li_Success = 0 then
    Write-Debug loo_Secrets.LastErrorText
    destroy loo_Bootstrap
    destroy loo_BsId
    destroy loo_Secrets
    destroy loo_JsonMatch
    destroy loo_Results
    return
end if

Write-Debug loo_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.

i = 0
li_NumSecrets = loo_Results.SizeOfArray("secrets")
do while i < li_NumSecrets
    loo_Results.I = i
    // Note: appName and domain are optional and may not exist in any given secret.
    ls_AppName = loo_Results.StringOf("secrets[i].appName")
    ls_Service = loo_Results.StringOf("secrets[i].service")
    ls_Domain = loo_Results.StringOf("secrets[i].domain")
    ls_Username = loo_Results.StringOf("secrets[i].username")
    // Informational field for the raw Azure secret name.
    ls_Azure_id = loo_Results.StringOf("secrets[i].azure_id")
    i = i + 1
loop


destroy loo_Bootstrap
destroy loo_BsId
destroy loo_Secrets
destroy loo_JsonMatch
destroy loo_Results