Perl

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.

Perl

use chilkat();

$success = 0;

# 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
$bootstrap = chilkat::CkSecrets->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->put_Location("local_manager");

# Specify the bootstrap secret to be used.
$bsId = chilkat::CkJsonObject->new();
$bsId->UpdateString("appName","azure_bs");
$bsId->UpdateString("service","Example");
$bsId->UpdateString("username","Joe");

# ----------------------------------------------------
$secrets = chilkat::CkSecrets->new();

# Setup for the Azure Key Vault
$secrets->put_Location("azure_key_vault");
$success = $secrets->SetBootstrapSecret($bsId,$bootstrap);
if ($success == 0) {
    print $secrets->lastErrorText() . "\r\n";
    exit;
}

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

$results = chilkat::CkJsonObject->new();
$results->put_EmitCompact(0);

$success = $secrets->ListSecrets($jsonMatch,$results);
if ($success == 0) {
    print $secrets->lastErrorText() . "\r\n";
    exit;
}

print $results->emit() . "\r\n";

# 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;
$numSecrets = $results->SizeOfArray("secrets");
while ($i < $numSecrets) {
    $results->put_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;
}