Lua Requires Chilkat v10.1.0+

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. Lua

local chilkat = require("chilkat")

-- 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
local bootstrap = chilkat.Secrets.new()

-- 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.
local bsId = chilkat.JsonObject.new()
bsId:update_string("appName", "azure_bs")
bsId:update_string("service", "Example")
bsId:update_string("username", "Joe")

-- ----------------------------------------------------
local secrets = chilkat.Secrets.new()

-- Setup for the Azure Key Vault
secrets.location = "azure_key_vault"
local success = secrets:set_bootstrap_secret(bsId, bootstrap)
if not success then
    print(secrets.last_error_text)
    return
end

-- 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.
local jsonMatch = chilkat.JsonObject.new()
jsonMatch:update_string("appName", "Test*")
-- The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
jsonMatch:update_string("service", "*")
jsonMatch:update_string("domain", "*")
jsonMatch:update_string("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.
jsonMatch:update_string("vaultName", "kvChilkat")

local results = chilkat.JsonObject.new()
results.emit_compact = false

success = secrets:list_secrets(jsonMatch, results)
if not success then
    print(secrets.last_error_text)
    return
end

print(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.

local appName = ""
local service = ""
local domain = ""
local username = ""
local azure_id = ""

local i = 0
local numSecrets = results:size_of_array("secrets")
while i < numSecrets do
    results.i = i
    -- Note: appName and domain are optional and may not exist in any given secret.
    appName = results:string_of("secrets[i].appName")
    service = results:string_of("secrets[i].service")
    domain = results:string_of("secrets[i].domain")
    username = results:string_of("secrets[i].username")
    -- Informational field for the raw Azure secret name.
    azure_id = results:string_of("secrets[i].azure_id")
    i = i + 1
end