DataFlex

Sign PDF in the Cloud using Azure Key Vault

See more Signing in the Cloud Examples

Demonstrates how to sign a PDF using Azure Key Vault. The signing of the hash happens in the Cloud on Azure Key Vault. Everything else involving the updating the PDF to add the signature happens locally within Chilkat.

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

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoPdf
    Variant vJson
    Handle hoJson
    Variant vCert
    Handle hoCert
    Variant vJsonAzure
    Handle hoJsonAzure
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatPdf)) To hoPdf
    If (Not(IsComObjectCreated(hoPdf))) Begin
        Send CreateComObject of hoPdf
    End

    // Load a PDF to be signed.
    Get ComLoadFile Of hoPdf "qa_data/pdf/helloWorld.pdf" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Options for signing are specified in JSON.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End

    // Optionally create an LTV-enabled signature
    Get ComUpdateBool Of hoJson "ltvOcsp" True To iSuccess

    // Define the appearance of the signature.
    Get ComUpdateInt Of hoJson "page" 1 To iSuccess
    Get ComUpdateString Of hoJson "appearance.y" "top" To iSuccess
    Get ComUpdateString Of hoJson "appearance.x" "left" To iSuccess
    Get ComUpdateString Of hoJson "appearance.fontScale" "10.0" To iSuccess
    Get ComUpdateString Of hoJson "appearance.text[0]" "Digitally signed by: cert_cn" To iSuccess
    Get ComUpdateString Of hoJson "appearance.text[1]" "current_dt" To iSuccess
    Get ComUpdateString Of hoJson "appearance.text[2]" "This is an LTV-enabled signature." To iSuccess

    // Load the certificate used for signing.  The certificate's private key is stored in 
    // the Azure Key Vault.
    // However, we still need the certificate locally (without private key).
    Get Create (RefClass(cComChilkatCert)) To hoCert
    If (Not(IsComObjectCreated(hoCert))) Begin
        Send CreateComObject of hoCert
    End
    Get ComLoadFromFile Of hoCert "qa_data/certs/myCert.cer" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCert To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Here's a screenshot of our certificate with private key on Azure Key Vault:
    // (image:https://example-code.com/images/azure_key_vault.jpg/endImage)

    // To sign using the Azure Key Vault, 
    // add the following lines of code to specify your authentication credentials,
    // and the name of the certificate w/ private key on the Azure server to be used.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonAzure
    If (Not(IsComObjectCreated(hoJsonAzure))) Begin
        Send CreateComObject of hoJsonAzure
    End
    // Set the "service" equal to "azure_keyvault" to tell Chilkat to use Azure Key Vault for signing.
    Get ComUpdateString Of hoJsonAzure "service" "azure_keyvault" To iSuccess
    Get ComUpdateString Of hoJsonAzure "client_id" "APP_ID" To iSuccess
    Get ComUpdateString Of hoJsonAzure "client_secret" "APP_PASSWORD" To iSuccess
    Get ComUpdateString Of hoJsonAzure "tenant_id" "TENANT_ID" To iSuccess
    // In the above screenshot, our vault name is "kvchilkat".  You will use your vault name.
    Get ComUpdateString Of hoJsonAzure "vault_name" "VAULT_NAME" To iSuccess
    // In the above screenshot, our cert name is "ChilkatTest1".  You will use your cert name.
    Get ComUpdateString Of hoJsonAzure "cert_name" "CERT_NAME" To iSuccess
    // In the above screenshot, our cert version is "63b94a23389546ecbc8eb6208a1bef37".  You will use your cert version.
    Get ComUpdateString Of hoJsonAzure "cert_version" "CERT_VERSION" To iSuccess
    Get pvComObject of hoJsonAzure to vJsonAzure
    Get ComSetCloudSigner Of hoCert vJsonAzure To iSuccess

    // Tell the pdf object to use the certificate for signing (and for Azure Key Vault to do the actual signing of the hash).
    Get pvComObject of hoCert to vCert
    Get ComSetSigningCert Of hoPdf vCert To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Chilkat will build the signed PDF locally, but will (internally) use Azure Key Vault
    // to do the RSA (or EC) sign hash operation.
    Get pvComObject of hoJson to vJson
    Get ComSignPdf Of hoPdf vJson "qa_output/hello_ltv_signed.pdf" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoPdf To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "PDF Cloud Signing using Azure Key Vault Successful."


End_Procedure