PureBasic

Azure Key Vault Get Certificates

See more Azure Key Vault Examples

Demonstrates how to list the certificates in an Azure Key Vault.

Note: This example requires Chilkat v9.5.0.96 or later.

PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; We demonstrated how to get an access token for your Azure Key Vault
    ; in this example: Azure Key Vault Get OAuth2 Access Token using Client Credentials

    ; However.. starting in Chilkat v9.5.0.96, instead of directly providing Chilkat with the OAuth2 access token,
    ; you can instead provide the means for Chilkat to automatically get the OAuth2 access token,
    ; and in addition, Chilkat will automatically re-fetch a new OAuth2 access token as needed, such as shortly 
    ; prior to or after expiration.

    ; You do this by setting the AuthToken property to a JSON string that contains the required information.

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

    CkJsonObject::ckUpdateString(json,"client_id","APP_ID")

    ; The APP_PASSWORD is the "password" returned by the Azure CLI command: az ad sp create-for-rbac --name http://example.com --role Contributor
    ; See Azure Key Vault Get OAuth2 Access Token using Client Credentials
    CkJsonObject::ckUpdateString(json,"client_secret","APP_PASSWORD")

    ; The access token will be for Azure Key Vault operations.
    CkJsonObject::ckUpdateString(json,"resource","https://vault.azure.net")

    ; Specify the token endpoint which includes your tenant ID.
    CkJsonObject::ckUpdateString(json,"token_endpoint","https://login.microsoftonline.com/TENANT_ID/oauth2/token")

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

    ; Instead of providing an actual access token, we give Chilkat the information that allows it to 
    ; automatically fetch the access token using the OAuth2 client credentials flow.
    CkHttp::setCkAuthToken(http, CkJsonObject::ckEmit(json))

    ; Replace key_vault_name with the name of your Azure Key Vault.
    sbResponse.i = CkStringBuilder::ckCreate()
    If sbResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://key_vault_name.vault.azure.net/certificates?api-version=7.4",sbResponse)
    If success = 0

        statusCode.i = CkHttp::ckLastStatus(http)
        If statusCode = 0
            ; We did not get a response from the server..
            Debug CkHttp::ckLastErrorText(http)
        Else
            ; We received a response, but it was an error.
            Debug "Error response status code: " + Str(statusCode)
            Debug "Error response:"
            Debug CkStringBuilder::ckGetAsString(sbResponse)
        EndIf

        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckLoadSb(jsonResp,sbResponse)
    CkJsonObject::setCkEmitCompact(jsonResp, 0)

    Debug CkJsonObject::ckEmit(jsonResp)

    ; The output looks like this:

    ; {
    ;   "value": [
    ;     {
    ;       "id": "https://kvchilkat.vault.azure.net/certificates/BadSSL",
    ;       "x5t": "U04xLnb8Ww7BKkW9dD7P1cCHNDY",
    ;       "attributes": {
    ;         "enabled": true,
    ;         "nbf": 1674409014,
    ;         "exp": 1737481014,
    ;         "created": 1697294224,
    ;         "updated": 1697294224
    ;       },
    ;       "subject": ""
    ;     },
    ;     {
    ;       "id": "https://kvchilkat.vault.azure.net/certificates/Brasil",
    ;       "x5t": "ayF5eBtlA35xPMivusE0wpmFjnA",
    ;       "attributes": {
    ;         "enabled": true,
    ;         "nbf": 1667830002,
    ;         "exp": 1699366002,
    ;         "created": 1697294090,
    ;         "updated": 1697294090
    ;       },
    ;       "subject": ""
    ;     }
    ;   ],
    ;   "nextLink": null
    ; }

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    id.s
    x5t.s
    Enabled.i
    Nbf.i
    Exp.i
    Created.i
    Updated.i
    subject.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResp,"value")
    While i < count_i
        CkJsonObject::setCkI(jsonResp, i)
        id = CkJsonObject::ckStringOf(jsonResp,"value[i].id")
        x5t = CkJsonObject::ckStringOf(jsonResp,"value[i].x5t")
        Enabled = CkJsonObject::ckBoolOf(jsonResp,"value[i].attributes.enabled")
        Nbf = CkJsonObject::ckIntOf(jsonResp,"value[i].attributes.nbf")
        Exp = CkJsonObject::ckIntOf(jsonResp,"value[i].attributes.exp")
        Created = CkJsonObject::ckIntOf(jsonResp,"value[i].attributes.created")
        Updated = CkJsonObject::ckIntOf(jsonResp,"value[i].attributes.updated")
        subject = CkJsonObject::ckStringOf(jsonResp,"value[i].subject")
        i = i + 1
    Wend


    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponse)
    CkJsonObject::ckDispose(jsonResp)


    ProcedureReturn
EndProcedure