(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkCert.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPdf.pb"

Procedure ChilkatExample()

    ; 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.i = CkPdf::ckCreate()
    If pdf.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Load a PDF to be signed.
    ; The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
    success.i = CkPdf::ckLoadFile(pdf,"qa_data/pdf/hello.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        ProcedureReturn
    EndIf

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

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

    ; Add the CMS options required for ICP-Brasil
    CkJsonObject::ckUpdateInt(json,"contentType",1)
    CkJsonObject::ckUpdateInt(json,"messageDigest",1)
    CkJsonObject::ckUpdateInt(json,"signingCertificateV2",1)
    CkJsonObject::ckUpdateBool(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::ckUpdateString(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.
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,"qa_data/pfx/myPdfSigningCert.pfx","pfx_password")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Tell the pdf object to use the certificate for signing.
    success = CkPdf::ckSetSigningCert(pdf,cert)
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkPdf::ckSignPdf(pdf,json,"qa_output/hello_signed.pdf")
    If success = 0
        Debug CkPdf::ckLastErrorText(pdf)
        CkPdf::ckDispose(pdf)
        CkJsonObject::ckDispose(json)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    Debug "The PDF has been successfully cryptographically signed."


    CkPdf::ckDispose(pdf)
    CkJsonObject::ckDispose(json)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure