(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"
IncludeFile "CkSecrets.pb"

Procedure ChilkatExample()

    ; 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.i = CkSecrets::ckCreate()
    If bootstrap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    ; ---------------------------------------------------------------------------------------------
    CkSecrets::setCkLocation(bootstrap, "local_manager")

    ; Specify the bootstrap secret to be used.
    bsId.i = CkJsonObject::ckCreate()
    If bsId.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(bsId,"appName","azure_bs")
    CkJsonObject::ckUpdateString(bsId,"service","Example")
    CkJsonObject::ckUpdateString(bsId,"username","Joe")

    ; ----------------------------------------------------
    secrets.i = CkSecrets::ckCreate()
    If secrets.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Setup for the Azure Key Vault
    CkSecrets::setCkLocation(secrets, "azure_key_vault")
    success.i = CkSecrets::ckSetBootstrapSecret(secrets,bsId,bootstrap)
    If success = 0
        Debug CkSecrets::ckLastErrorText(secrets)
        CkSecrets::ckDispose(bootstrap)
        CkJsonObject::ckDispose(bsId)
        CkSecrets::ckDispose(secrets)
        ProcedureReturn
    EndIf

    ; 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.i = CkJsonObject::ckCreate()
    If jsonMatch.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    results.i = CkJsonObject::ckCreate()
    If results.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(results, 0)

    success = CkSecrets::ckListSecrets(secrets,jsonMatch,results)
    If success = 0
        Debug CkSecrets::ckLastErrorText(secrets)
        CkSecrets::ckDispose(bootstrap)
        CkJsonObject::ckDispose(bsId)
        CkSecrets::ckDispose(secrets)
        CkJsonObject::ckDispose(jsonMatch)
        CkJsonObject::ckDispose(results)
        ProcedureReturn
    EndIf

    Debug CkJsonObject::ckEmit(results)

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

    appName.s
    service.s
    domain.s
    username.s
    azure_id.s

    i.i = 0
    numSecrets.i = CkJsonObject::ckSizeOfArray(results,"secrets")
    While i < numSecrets
        CkJsonObject::setCkI(results, i)
        ; Note: appName and domain are optional and may not exist in any given secret.
        appName = CkJsonObject::ckStringOf(results,"secrets[i].appName")
        service = CkJsonObject::ckStringOf(results,"secrets[i].service")
        domain = CkJsonObject::ckStringOf(results,"secrets[i].domain")
        username = CkJsonObject::ckStringOf(results,"secrets[i].username")
        ; Informational field for the raw Azure secret name.
        azure_id = CkJsonObject::ckStringOf(results,"secrets[i].azure_id")
        i = i + 1
    Wend


    CkSecrets::ckDispose(bootstrap)
    CkJsonObject::ckDispose(bsId)
    CkSecrets::ckDispose(secrets)
    CkJsonObject::ckDispose(jsonMatch)
    CkJsonObject::ckDispose(results)


    ProcedureReturn
EndProcedure