(Tcl) Sign PDF for ICP-Brasil

See more PDF Signatures Examples

Sign a PDF to create a signed PDF compliant with the ICP-Brasil Digital Signature Standard Conformity Checker. (Verificador de Conformidade do Padrão de Assinatura Digital ICP-Brasil)

For more information, see https://verificador.iti.gov.br/verifier-2.6.2/

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.

# The signed PDF produced by this example should be verifiable at https://validar.iti.gov.br/
set pdf [new_CkPdf]

# Load a PDF to be signed.
# The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
set success [CkPdf_LoadFile $pdf "qa_data/pdf/hello.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    exit
}

set json [new_CkJsonObject]

# Define the appearance and location of the signature.
CkJsonObject_UpdateInt $json "page" 1
CkJsonObject_UpdateString $json "appearance.y" "bottom"
CkJsonObject_UpdateString $json "appearance.x" "middle"
CkJsonObject_UpdateString $json "appearance.fontScale" "9.0"
CkJsonObject_UpdateString $json "appearance.text[0]" "Digitally signed by: cert_cn"
CkJsonObject_UpdateString $json "appearance.text[1]" "current_dt"
CkJsonObject_UpdateString $json "appearance.image" "document-accepted"
CkJsonObject_UpdateString $json "appearance.imagePlacement" "left"
CkJsonObject_UpdateString $json "appearance.imageOpacity" "100"

# Add the CMS options required for ICP-Brasil
CkJsonObject_UpdateInt $json "contentType" 1
CkJsonObject_UpdateInt $json "messageDigest" 1
CkJsonObject_UpdateInt $json "signingCertificateV2" 1
CkJsonObject_UpdateBool $json "ltvOcsp" 1

# Listed here are the currently existing profiles. (Chilkat will add additional ICP Brasil policy profiles in future versions as new ones are created.)
# See https://www.gov.br/iti/pt-br/assuntos/repositorio/artefatos-de-assinatura-digital for more information.
# 
# PA_AD_RA_v1_1 --> 2.16.76.1.7.1.5.1.1
# PA_AD_RA_v1_2 --> 2.16.76.1.7.1.5.1.2
# PA_AD_RA_v2_0 --> 2.16.76.1.7.1.5.2
# PA_AD_RA_v2_1 --> 2.16.76.1.7.1.5.2.1
# PA_AD_RA_v2_2 --> 2.16.76.1.7.1.5.2.2
# PA_AD_RA_v2_3 --> 2.16.76.1.7.1.5.2.3
# PA_AD_RA_v2_4 --> 2.16.76.1.7.1.5.2.4

# PA_AD_RB_v1_1 --> 2.16.76.1.7.1.1.1.1
# PA_AD_RB_v2_0 --> 2.16.76.1.7.1.1.2
# PA_AD_RB_v2_1 --> 2.16.76.1.7.1.1.2.1
# PA_AD_RB_v2_2 --> 2.16.76.1.7.1.1.2.2
# PA_AD_RB_v2_3 --> 2.16.76.1.7.1.1.2.3

# PA_AD_RC_v1_1 --> 2.16.76.1.7.1.4.1.1
# PA_AD_RC_v2_0 --> 2.16.76.1.7.1.4.2
# PA_AD_RC_v2_1 --> 2.16.76.1.7.1.4.2.1
# PA_AD_RC_v2_2 --> 2.16.76.1.7.1.4.2.2
# PA_AD_RC_v2_3 --> 2.16.76.1.7.1.4.2.3

# PA_AD_RT_v1_1 --> 2.16.76.1.7.1.2.1.1
# PA_AD_RT_v2_0 --> 2.16.76.1.7.1.2.2
# PA_AD_RT_v2_1 --> 2.16.76.1.7.1.2.2.1
# PA_AD_RT_v2_2 --> 2.16.76.1.7.1.2.2.2
# PA_AD_RT_v2_3 --> 2.16.76.1.7.1.2.2.3

# PA_AD_RV_v1_1 --> 2.16.76.1.7.1.3.1.1
# PA_AD_RV_v2_0 --> 2.16.76.1.7.1.3.2
# PA_AD_RV_v2_1 --> 2.16.76.1.7.1.3.2.1
# PA_AD_RV_v2_2 --> 2.16.76.1.7.1.3.2.2
# PA_AD_RV_v2_3 --> 2.16.76.1.7.1.3.2.3

# PA_PAdES_AD_RA_v1_0 --> 2.16.76.1.7.1.14.1
# PA_PAdES_AD_RA_v1_1 --> 2.16.76.1.7.1.14.1.1
# PA_PAdES_AD_RA_v1_2 --> 2.16.76.1.7.1.14.1.2
# PA_PAdES_AD_RB_v1_0 --> 2.16.76.1.7.1.11.1
# PA_PAdES_AD_RB_v1_1 --> 2.16.76.1.7.1.11.1.1
# PA_PAdES_AD_RC_v1_0 --> 2.16.76.1.7.1.13.1
# PA_PAdES_AD_RC_v1_1 --> 2.16.76.1.7.1.13.1.1
# PA_PAdES_AD_RC_v1_2 --> 2.16.76.1.7.1.13.1.2
# PA_PAdES_AD_RT_v1_0 --> 2.16.76.1.7.1.12.1
# PA_PAdES_AD_RT_v1_1 --> 2.16.76.1.7.1.12.1.1

# Set the policy profile name
# ---------------------------------------------------
# Note: On 24-May-2024, I was informed that adding the "policyId.profile"
# causes the PDF signature to fail validation at https://validar.iti.gov.br/
# Perhaps something changed in the years since this example was originally written and tested to be working.
# You may need to omit the "policyId.profile".
# ---------------------------------------------------
CkJsonObject_UpdateString $json "policyId.profile" "PA_PAdES_AD_RB_v1_1"

# Load the signing certificate. (Use your own certificate.)
# Note: If loading from a smart card, call LoadFromSmartcard instead, and make sure to use Chilkat v9.5.0.88 or later.
set cert [new_CkCert]

set success [CkCert_LoadPfxFile $cert "qa_data/pfx/myPdfSigningCert.pfx" "pfx_password"]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkCert $cert
    exit
}

# Tell the pdf object to use the certificate for signing.
set success [CkPdf_SetSigningCert $pdf $cert]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkCert $cert
    exit
}

set success [CkPdf_SignPdf $pdf $json "qa_output/hello_signed.pdf"]
if {$success == 0} then {
    puts [CkPdf_lastErrorText $pdf]
    delete_CkPdf $pdf
    delete_CkJsonObject $json
    delete_CkCert $cert
    exit
}

puts "The PDF has been successfully cryptographically signed."

delete_CkPdf $pdf
delete_CkJsonObject $json
delete_CkCert $cert