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

For more information, see https://cknotes.com/chilkat-secrets-class-added-in-version-10-1-0/

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoSecrets.h>
#import <CkoJsonObject.h>
#import <NSString.h>

// 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
CkoSecrets *bootstrap = [[CkoSecrets alloc] init];

// 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.
CkoJsonObject *bsId = [[CkoJsonObject alloc] init];
[bsId UpdateString: @"appName" value: @"azure_bs"];
[bsId UpdateString: @"service" value: @"Example"];
[bsId UpdateString: @"username" value: @"Joe"];

// ----------------------------------------------------
CkoSecrets *secrets = [[CkoSecrets alloc] init];

// Setup for the Azure Key Vault
secrets.Location = @"azure_key_vault";
BOOL success = [secrets SetBootstrapSecret: bsId secrets: bootstrap];
if (success == NO) {
    NSLog(@"%@",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.
CkoJsonObject *jsonMatch = [[CkoJsonObject alloc] init];
[jsonMatch UpdateString: @"appName" value: @"Test*"];
// The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
[jsonMatch UpdateString: @"service" value: @"*"];
[jsonMatch UpdateString: @"domain" value: @"*"];
[jsonMatch UpdateString: @"username" value: @"*"];

// 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" value: @"kvChilkat"];

CkoJsonObject *results = [[CkoJsonObject alloc] init];
results.EmitCompact = NO;

success = [secrets ListSecrets: jsonMatch jsonOut: results];
if (success == NO) {
    NSLog(@"%@",secrets.LastErrorText);
    return;
}

NSLog(@"%@",[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.

NSString *appName = 0;
NSString *service = 0;
NSString *domain = 0;
NSString *username = 0;
NSString *azure_id = 0;

int i = 0;
int numSecrets = [[results SizeOfArray: @"secrets"] intValue];
while (i < numSecrets) {
    results.I = [NSNumber numberWithInt: 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;
}