(Tcl) 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.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set pdf [new_CkPdf]

# Load a PDF to be signed.
set success [CkPdf_LoadFile $pdf "qa_data/pdf/helloWorld.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    exit
}

# Options for signing are specified in JSON.
set json [new_CkJsonObject]

# Optionally create an LTV-enabled signature
CkJsonObject_UpdateBool $json "ltvOcsp" 1

# Define the appearance of the signature.
CkJsonObject_UpdateInt $json "page" 1
CkJsonObject_UpdateString $json "appearance.y" "top"
CkJsonObject_UpdateString $json "appearance.x" "left"
CkJsonObject_UpdateString $json "appearance.fontScale" "10.0"
CkJsonObject_UpdateString $json "appearance.text[0]" "Digitally signed by: cert_cn"
CkJsonObject_UpdateString $json "appearance.text[1]" "current_dt"
CkJsonObject_UpdateString $json "appearance.text[2]" "This is an LTV-enabled signature."

# 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).
set cert [new_CkCert]

set success [CkCert_LoadFromFile $cert "qa_data/certs/myCert.cer"]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkCert $cert
    exit
}

# Here's a screenshot of our certificate with private key on Azure Key Vault:


# 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.
set jsonAzure [new_CkJsonObject]

# Set the "service" equal to "azure_keyvault" to tell Chilkat to use Azure Key Vault for signing.
CkJsonObject_UpdateString $jsonAzure "service" "azure_keyvault"
CkJsonObject_UpdateString $jsonAzure "client_id" "APP_ID"
CkJsonObject_UpdateString $jsonAzure "client_secret" "APP_PASSWORD"
CkJsonObject_UpdateString $jsonAzure "tenant_id" "TENANT_ID"
# In the above screenshot, our vault name is "kvchilkat".  You will use your vault name.
CkJsonObject_UpdateString $jsonAzure "vault_name" "VAULT_NAME"
# In the above screenshot, our cert name is "ChilkatTest1".  You will use your cert name.
CkJsonObject_UpdateString $jsonAzure "cert_name" "CERT_NAME"
# In the above screenshot, our cert version is "63b94a23389546ecbc8eb6208a1bef37".  You will use your cert version.
CkJsonObject_UpdateString $jsonAzure "cert_version" "CERT_VERSION"
set success [CkCert_SetCloudSigner $cert $jsonAzure]

# Tell the pdf object to use the certificate for signing (and for Azure Key Vault to do the actual signing of the hash).
set success [CkPdf_SetSigningCert $pdf $cert]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkCert $cert
    delete_CkJsonObject $jsonAzure
    exit
}

# Chilkat will build the signed PDF locally, but will (internally) use Azure Key Vault
# to do the RSA (or EC) sign hash operation.
set success [CkPdf_SignPdf $pdf $json "qa_output/hello_ltv_signed.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkCert $cert
    delete_CkJsonObject $jsonAzure
    exit
}

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

delete_CkPdf $pdf
delete_CkJsonObject $json
delete_CkCert $cert
delete_CkJsonObject $jsonAzure