(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Variant vBootstrap
    Handle hoBootstrap
    Variant vBsId
    Handle hoBsId
    Boolean iSuccess
    Handle hoSecrets
    Boolean iSuccess
    Variant vJsonMatch
    Handle hoJsonMatch
    Variant vResults
    Handle hoResults
    String sAppName
    String sService
    String sDomain
    String sUsername
    String sAzure_id
    Integer i
    Integer iNumSecrets
    String sTemp1

    // 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
    Get Create (RefClass(cComChilkatSecrets)) To hoBootstrap
    If (Not(IsComObjectCreated(hoBootstrap))) Begin
        Send CreateComObject of hoBootstrap
    End

    // 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.
    // ---------------------------------------------------------------------------------------------
    Set ComLocation Of hoBootstrap To "local_manager"

    // Specify the bootstrap secret to be used.
    Get Create (RefClass(cComChilkatJsonObject)) To hoBsId
    If (Not(IsComObjectCreated(hoBsId))) Begin
        Send CreateComObject of hoBsId
    End
    Get ComUpdateString Of hoBsId "appName" "azure_bs" To iSuccess
    Get ComUpdateString Of hoBsId "service" "Example" To iSuccess
    Get ComUpdateString Of hoBsId "username" "Joe" To iSuccess

    // ----------------------------------------------------
    Get Create (RefClass(cComChilkatSecrets)) To hoSecrets
    If (Not(IsComObjectCreated(hoSecrets))) Begin
        Send CreateComObject of hoSecrets
    End

    // Setup for the Azure Key Vault
    Set ComLocation Of hoSecrets To "azure_key_vault"
    Get pvComObject of hoBsId to vBsId
    Get pvComObject of hoBootstrap to vBootstrap
    Get ComSetBootstrapSecret Of hoSecrets vBsId vBootstrap To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSecrets To sTemp1
        Showln sTemp1
        Procedure_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.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonMatch
    If (Not(IsComObjectCreated(hoJsonMatch))) Begin
        Send CreateComObject of hoJsonMatch
    End
    Get ComUpdateString Of hoJsonMatch "appName" "Test*" To iSuccess
    // The following lines can be omitted. Not specifying anything for service, domain, or username is the same as "*".
    Get ComUpdateString Of hoJsonMatch "service" "*" To iSuccess
    Get ComUpdateString Of hoJsonMatch "domain" "*" To iSuccess
    Get ComUpdateString Of hoJsonMatch "username" "*" To iSuccess

    // 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.
    Get ComUpdateString Of hoJsonMatch "vaultName" "kvChilkat" To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoResults
    If (Not(IsComObjectCreated(hoResults))) Begin
        Send CreateComObject of hoResults
    End
    Set ComEmitCompact Of hoResults To False

    Get pvComObject of hoJsonMatch to vJsonMatch
    Get pvComObject of hoResults to vResults
    Get ComListSecrets Of hoSecrets vJsonMatch vResults To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSecrets To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComEmit Of hoResults To sTemp1
    Showln sTemp1

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

    Move 0 To i
    Get ComSizeOfArray Of hoResults "secrets" To iNumSecrets
    While (i < iNumSecrets)
        Set ComI Of hoResults To i
        // Note: appName and domain are optional and may not exist in any given secret.
        Get ComStringOf Of hoResults "secrets[i].appName" To sAppName
        Get ComStringOf Of hoResults "secrets[i].service" To sService
        Get ComStringOf Of hoResults "secrets[i].domain" To sDomain
        Get ComStringOf Of hoResults "secrets[i].username" To sUsername
        // Informational field for the raw Azure secret name.
        Get ComStringOf Of hoResults "secrets[i].azure_id" To sAzure_id
        Move (i + 1) To i
    Loop



End_Procedure