CMS

Learn how to sign and verify messages using the CMS component.

CMS signs and verifies messages based on a certificates chain.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Parameter	Description	Default value	Data type
Account	Use this parameter to set the account to be used by the component. Supported accounts: Certificate Chain.	N/A	N/A
Operation	Component operation types (Sign Fields, Sign Payload, or Verify).	Sign Payload	N/A
Charset	Name of the character code for file reading.	UTF-8	String
Hash Algorithm	Algorithm to be used to sign/verify the data (e.g., SHA256WithRSA). This field is available only when Sign Fields or Sign Payload are selected in the Operation parameter.	SHA1withRSA	String
Original	Original message signed for verification. This field is available only when Verify is selected in the Operation parameter.	N/A	String
Signed (DB)	Base64 or hex-type base to be verified against the payload. This field is available only when Verify is selected in the Operation parameter.	N/A	String
Sign Fields	Fields to be signed/verified (must be separated by comma). This field is available only when Sign Fields is selected in the Operation parameter.	N/A	String
Payload (DB)	Defined with a unique value or Double Braces. This field is available only when Sign Payload is selected in the Operation parameter.	N/A	String
Hash in Hexadecimal	If the option is active, the value to be verified/signed must be informed in hex format; otherwise, it will be signed or verified as base64.	False	Boolean
Encapsulated	If the option is active, the content should be encapsulated in the signature; otherwise, the content will not be encapsulated.	False	Boolean
Fail On Error	If the option is enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Important: to sign and verify, you must configure a Certificate Chain account.

CMS in Action

Operation Sign Fields

Input

{  
    "parameter": "TEXT TO BE Signed"
}

Output

{  
    "parameter": "AA01FF" // text Signed
}

Operation Sign Payload

Input

{  
    "parameter": "TEXT TO BE Signed"
}

Output

{  
    "result": "AA01FF" // text Signed
}

Request answer with error

{  
    "error": "java.io.FileNotFoundException: data1.csv (No such file or directory)",  
    "message": "Encountered an I/O error while executing ZipFileConnector",  
    "success": false
}