(SQL Server) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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/
    DECLARE @pdf int
    -- Use "Chilkat_9_5_0.Pdf" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Pdf', @pdf OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Load a PDF to be signed.
    -- The "hello.pdf" is available at https://chilkatsoft.com/hello.pdf
    DECLARE @success int
    EXEC sp_OAMethod @pdf, 'LoadFile', @success OUT, 'qa_data/pdf/hello.pdf'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pdf, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        RETURN
      END

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    -- Define the appearance and location of the signature.
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'page', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.y', 'bottom'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.x', 'middle'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.fontScale', '9.0'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.text[0]', 'Digitally signed by: cert_cn'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.text[1]', 'current_dt'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.image', 'document-accepted'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.imagePlacement', 'left'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'appearance.imageOpacity', '100'

    -- Add the CMS options required for ICP-Brasil
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'contentType', 1
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'messageDigest', 1
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'signingCertificateV2', 1
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, '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".
    -- ---------------------------------------------------
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, '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.
    DECLARE @cert int
    -- Use "Chilkat_9_5_0.Cert" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Cert', @cert OUT

    EXEC sp_OAMethod @cert, 'LoadPfxFile', @success OUT, 'qa_data/pfx/myPdfSigningCert.pfx', 'pfx_password'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @cert, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    -- Tell the pdf object to use the certificate for signing.
    EXEC sp_OAMethod @pdf, 'SetSigningCert', @success OUT, @cert
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pdf, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END

    EXEC sp_OAMethod @pdf, 'SignPdf', @success OUT, @json, 'qa_output/hello_signed.pdf'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @pdf, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @pdf
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @cert
        RETURN
      END


    PRINT 'The PDF has been successfully cryptographically signed.'

    EXEC @hr = sp_OADestroy @pdf
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @cert


END
GO