(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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
    let bootstrap = CkoSecrets()!

    // 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.
    let bsId = CkoJsonObject()!
    bsId.update("appName", value: "azure_bs")
    bsId.update("service", value: "Example")
    bsId.update("username", value: "Joe")

    // ----------------------------------------------------
    let secrets = CkoSecrets()!

    // Setup for the Azure Key Vault
    secrets.location = "azure_key_vault"
    var success: Bool = secrets.setBootstrapSecret(bsId, secrets: bootstrap)
    if success == false {
        print("\(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.
    let jsonMatch = CkoJsonObject()!
    jsonMatch.update("appName", value: "Test*")
    // The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    jsonMatch.update("service", value: "*")
    jsonMatch.update("domain", value: "*")
    jsonMatch.update("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.update("vaultName", value: "kvChilkat")

    let results = CkoJsonObject()!
    results.emitCompact = false

    success = secrets.list(jsonMatch, jsonOut: results)
    if success == false {
        print("\(secrets.lastErrorText!)")
        return
    }

    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.

    var appName: String?
    var service: String?
    var domain: String?
    var username: String?
    var azure_id: String?

    var i: Int = 0
    var numSecrets: Int = results.size(ofArray: "secrets").intValue
    while i < numSecrets {
        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
    }


}