/pdfMetadata

Retrieves some basic information about a PDF document, like:

  • Number and size of pages
  • Signatures
  • Unsigned signature fields
  • PDF/A claimed level

This operation is not costly as no extensive validation of signatures or PDF/A conformity is done.

By command line:

csa -pdfmetadata -in c:/tmp/myfile.pdf

post

/validatePDFA

Verifies that a PDF/A document complies to the claimed level included in the document. This function cannot be used to verify conformance for a level different than the one present in the document.

By command line:

csa -validatepdfa -in c:/tmp/myfile.pdf

post

/validatePDF

Complete validation of all the signatures appearing on the document. Validation of a signature is based on 3 sub-validations:

  • Integrity (was the document modified after signature ?)
  • Origin (signed by a trusted signer at signature time or custom date ?)
  • Time (issued by certified timestamp authority or taken from local machine ?)

Every signature on a document contains a result for each of these aspect. The global document result (document authenticity) ie equals to the worse result appearing in the document.

By command line:

csa -validatepdf -in c:/tmp/myfile.pdf

post

/convertToPDFA

Converts a document to PDF/A using the level passed as parameter.

By command line:

csa -converttopdfa -in c:/tmp/myfile.pdf -level PDF/A-1b

post

/signPDF

Digitally signs a PDF document. The signature can be invisible or visible (using an image).

By command line:

csa -signpdf -device "c:/signature.epf" -devicetype epf -password c:/tmp/consigno-sdk/00000000.ual
-in c:/tmp/consigno-sdk/vide.pdf -out c:/tmp/consigno-sdk/signed.pdf
-reason "I am the author" -fieldname "Signature1" -img "c:/tmp/image.png"

post

/prepareExtSignPDF

An external signature is a signature which is done in a different time/place than where the document resides. For example, a document could be prepared server-side, and only a small data structure could be sent client-side for signature. This method is bandwidth-effective, as the full document does not travel client-side to be signed.

An external signature has 3 steps:

  1. Preparation step
    • Prepare document to be signed using the signature certificate
    • Calculate data structure to be signed
  2. Signature step
    • This step can be done at a different time/place than where the preparation step occured. Typically, the data structure is sent client-side, where the digital signature private key resides.
    • This step can be done with any technology supporting RSA digital signature. The algorithm that needs to be used is called PKCS#1 v1.5 (NoneWithRSA in Java).
  3. Finalization step
    • The resulting signature is embedded in the document prepared in the previous preparation step.

By command line:

csa -prepareextsignpdf -in c:/tmp/myfile.pdf -certificate c:/tmp/certificate.cer
-reason "I am the author" -fieldname "Signature1" -img "c:/tmp/image.png"

post

/finalizeExtSignPDF

Finalizes a document signature. See /prepareExtSignPDF for details on what happens.

By command line:

csa -finalizeextsignpdf -processid 6b50d524-4a6d-4b39-a84a-f57195641b7c
-in base64EncodedRawSignature -out c:/tmp/signed.pdf

post

/signCMSDetached

A CMS signature (Cryptographic Message Syntax) allows signing of any data formats. In a detached mode, the resulting signature is saved in a separate file (.p7s). The signed document is never modified in the process.

By command line:

csa -signcmsdetached -device "c:/signature.epf"
-devicetype epf -password c:/tmp/consigno-sdk/00000000.ual
-in c:/tmp/consigno-sdk/vide.pdf -out c:/tmp/consigno-sdk/signature_file.p7s

This operation is currently unsupported as a web service call.

/signCMSEnveloped

A CMS signature (Cryptographic Message Syntax) allows signing of any data formats. In an enveloped mode, the resulting file (.p7m) includes both the signature and the original document. The signed document is never modified in the process.

By command line:

csa -signcmsEnveloped -device "c:/signature.epf"
-devicetype epf -password c:/tmp/password.ual
-in c:/tmp/myfile.doc -out c:/tmp/signature_file.p7s

This operation is currently unsupported as a web service call.

/prepareExtSignCMS

Similar to an external PDF signature, but CMS-based. See /prepareExtSignPDF for further explanations.

By command line:

csa -prepareextsigncms -in c:/tmp/myfile.doc -certificate c:/tmp/certificate.cer -algorithm SHA256

post

/finalizeExtSignCMS

Similar to an external PDF signature, but CMS-based. See /finalizeExtSignPDF for further explanations.

By command line:

csa -finalizeextsigncms -processid 6b50d524-4a6d-4b39-a84a-f57195641b7c
-in base64EncodedRawSignature -out c:/tmp/signed.p7m -encapsulate true

post

/fillForm

Fills a PDF form.

By command line:

csa -fillform -in pdffile.pdf -out c:/tmp/filled.pdf
-fieldvalues "fieldname1:value1" "fieldname2:value2"

post

/applyTemplate

Applies a ConsignO Desktop template to a PDF. A template is a descriptor of one or more signature fields. This is used when signature fields placement if predictable.

By command line:

csa -applytemplate -in pdffile.pdf -out c:/tmp/pdffile_w_zone.pdf
-template "c:/tmp/template.xml"

post

/addEmbeddedFiles

Adds one or more files to the PDF, as attached files.

By command line:

csa -addembeddedfiles -in pdffile.pdf -out c:/tmp/pdffile_w_files.pdf
-files "c:/tmp/data1.xml" "c:/tmp/data2.xml"

post