(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

// 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
loBootstrap = createobject("CkSecrets")

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

// Specify the bootstrap secret to be used.
loBsId = createobject("CkJsonObject")
loBsId.UpdateString("appName","azure_bs")
loBsId.UpdateString("service","Example")
loBsId.UpdateString("username","Joe")

// ----------------------------------------------------
loSecrets = createobject("CkSecrets")

// Setup for the Azure Key Vault
loSecrets.Location = "azure_key_vault"
llSuccess = loSecrets.SetBootstrapSecret(loBsId,loBootstrap)
if (llSuccess = .F.) then
    ? loSecrets.LastErrorText
    release loBootstrap
    release loBsId
    release loSecrets
    return
endif

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

loResults = createobject("CkJsonObject")
loResults.EmitCompact = .F.

llSuccess = loSecrets.ListSecrets(loJsonMatch,loResults)
if (llSuccess = .F.) then
    ? loSecrets.LastErrorText
    release loBootstrap
    release loBsId
    release loSecrets
    release loJsonMatch
    release loResults
    return
endif

? loResults.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
lnNumSecrets = loResults.SizeOfArray("secrets")
do while i < lnNumSecrets
    loResults.I = i
    // Note: appName and domain are optional and may not exist in any given secret.
    lcAppName = loResults.StringOf("secrets[i].appName")
    lcService = loResults.StringOf("secrets[i].service")
    lcDomain = loResults.StringOf("secrets[i].domain")
    lcUsername = loResults.StringOf("secrets[i].username")
    // Informational field for the raw Azure secret name.
    lcAzure_id = loResults.StringOf("secrets[i].azure_id")
    i = i + 1
enddo


release loBootstrap
release loBsId
release loSecrets
release loJsonMatch
release loResults