Unicode C++

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.

Unicode C++

#include <CkSecretsW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    bool success = false;

    // 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
    CkSecretsW bootstrap;

    // 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(L"local_manager");

    // Specify the bootstrap secret to be used.
    CkJsonObjectW bsId;
    bsId.UpdateString(L"appName",L"azure_bs");
    bsId.UpdateString(L"service",L"Example");
    bsId.UpdateString(L"username",L"Joe");

    // ----------------------------------------------------
    CkSecretsW secrets;

    // Setup for the Azure Key Vault
    secrets.put_Location(L"azure_key_vault");
    success = secrets.SetBootstrapSecret(bsId,bootstrap);
    if (success == false) {
        wprintf(L"%s\n",secrets.lastErrorText());
        return;
    }

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

    // 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(L"vaultName",L"kvChilkat");

    CkJsonObjectW results;
    results.put_EmitCompact(false);

    success = secrets.ListSecrets(jsonMatch,results);
    if (success == false) {
        wprintf(L"%s\n",secrets.lastErrorText());
        return;
    }

    wprintf(L"%s\n",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.

    const wchar_t *appName = 0;
    const wchar_t *service = 0;
    const wchar_t *domain = 0;
    const wchar_t *username = 0;
    const wchar_t *azure_id = 0;

    int i = 0;
    int numSecrets = results.SizeOfArray(L"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(L"secrets[i].appName");
        service = results.stringOf(L"secrets[i].service");
        domain = results.stringOf(L"secrets[i].domain");
        username = results.stringOf(L"secrets[i].username");
        // Informational field for the raw Azure secret name.
        azure_id = results.stringOf(L"secrets[i].azure_id");
        i = i + 1;
    }
    }