Ruby

Create ICP-Brasil Compliant CMS Signature

See more CAdES Examples

Demonstrates how to create a .p7s signature that contains a data file, which in this case is a PDF. The .p7s will be compliant with the ICP-Brazil Digital Signature Standard.

The .p7s file created by this example can be verified at ICP-Brasil Online Verifier

Ruby

require 'chilkat'

success = false

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

# ------------------------------------------------------------------------------------------------------
# Note: This example creates a CMS signature (.p7s) that contains the PDF.
# It is different than signing a PDF.  To sign a PDF where the resulting PDF contains the CMS signature,
# see this example:  Sign PDF for ICP-Brasil
# ------------------------------------------------------------------------------------------------------
crypt = Chilkat::CkCrypt2.new()

# Any type of file can be signed.  It doesn't have to be a PDF.
inFile = "qa_data/pdf/helloWorld.pdf"

bd = Chilkat::CkBinData.new()
success = bd.LoadFile(inFile)
if (success == false)
    print "Failed to load " + inFile + "\n";
    exit
end

# We'll be using a certificate w/ private key stored on a smartcard for signing.
cert = Chilkat::CkCert.new()

# If the smartcard or token requires a PIN, we can set it here to avoid the dialog...
cert.put_SmartCardPin("000000")

success = cert.LoadFromSmartcard("")
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

# Tell the crypt component to use this cert.
success = crypt.SetSigningCert(cert)
if (success != true)
    print crypt.lastErrorText() + "\n";
    exit
end

# Set properties for signing...
crypt.put_HashAlgorithm("sha256")

jsonSigningAttrs = Chilkat::CkJsonObject.new()
jsonSigningAttrs.UpdateInt("contentType",1)
jsonSigningAttrs.UpdateInt("signingTime",1)
jsonSigningAttrs.UpdateInt("messageDigest",1)
jsonSigningAttrs.UpdateBool("signingCertificateV2",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 --> 2.16.76.1.7.1.5.1
# 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 --> 2.16.76.1.7.1.1.1
# 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 --> 2.16.76.1.7.1.4.1
# 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 --> 2.16.76.1.7.1.2.1
# 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 --> 2.16.76.1.7.1.3.1
# 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

# Set the policy OID and the profile name
jsonSigningAttrs.UpdateString("policyId.id","2.16.76.1.7.1.1.2.3")
jsonSigningAttrs.UpdateString("policyId.profile","PA_AD_RB_v2_3")

crypt.put_SigningAttributes(jsonSigningAttrs.emit())

# The Brazil government validator requires the ASN.1 data to be in "constructed octets" form..
crypt.put_UncommonOptions("UseConstructedOctets,OmitAlgorithmIdNull")
crypt.put_IncludeCertChain(false)

# Sign. 
success = crypt.OpaqueSignBd(bd)
if (success == false)
    print crypt.lastErrorText() + "\n";
    exit
end

# Save to a .p7s
success = bd.WriteFile("qa_output/helloWorld.pdf.p7s")

print "Success" + "\n";