(Chilkat2-Python) 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/

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

# 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/
pdf = chilkat2.Pdf()

# Load a PDF to be signed.
# The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
success = pdf.LoadFile("qa_data/pdf/hello.pdf")
if (success == False):
    print(pdf.LastErrorText)
    sys.exit()

json = chilkat2.JsonObject()

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

# Add the CMS options required for ICP-Brasil
json.UpdateInt("contentType",1)
json.UpdateInt("messageDigest",1)
json.UpdateInt("signingCertificateV2",1)
json.UpdateBool("ltvOcsp",True)

# 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".
# ---------------------------------------------------
json.UpdateString("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.
cert = chilkat2.Cert()
success = cert.LoadPfxFile("qa_data/pfx/myPdfSigningCert.pfx","pfx_password")
if (success == False):
    print(cert.LastErrorText)
    sys.exit()

# Tell the pdf object to use the certificate for signing.
success = pdf.SetSigningCert(cert)
if (success == False):
    print(pdf.LastErrorText)
    sys.exit()

success = pdf.SignPdf(json,"qa_output/hello_signed.pdf")
if (success == False):
    print(pdf.LastErrorText)
    sys.exit()

print("The PDF has been successfully cryptographically signed.")