N/crypto/certificate Module Features...

The N/crypto/certificate module is essential for SuiteScript developers focused on securely signing XML data. This module provides methods to create digital signatures and verify them, thereby ensuring data integrity during transactions.

What Are the Key Features of the N/crypto/certificate Module?

The N/crypto/certificate module includes the following core members:

Objects

Name	Return Type	Supported Script Types	Description
`certificate.SignedXml`	Object	Server scripts	Encapsulates an XML string that has been digitally signed.
`certificate.Signer`	Object	Server scripts	Encapsulates a created signature (signer) for plain strings.
`certificate.Verifier`	Object	Server scripts	Encapsulates a created verifier for verifying plain string signatures.

Methods

Name	Return Type	Supported Script Types	Description
`certificate.createSigner(options)`	`certificate.Signer`	Server scripts	Creates a certificate.Signer object for signing plain strings.
`certificate.createVerifier(options)`	`certificate.Verifier`	Server scripts	Creates a certificate.Verifier object for verifying signatures of plain strings.
`certificate.signXml(options)`	`certificate.SignedXml`	Server scripts	Signs the input XML string using the Certificate ID, returning a signed XML object.
`certificate.verifyXmlSignature(options)`	void	Server scripts	Verifies the signature in the SignedXml file.

Enums

Name	Type	Supported Script Types	Description
`certificate.HashAlg`	enum	Server scripts	Holds string values for hash algorithm types, used in signing and verifying methods.

How to Use the N/crypto/certificate Module

To use the module for signing and verifying XML signatures, follow the syntax shown below:

suitescript

1// Establishing a signedXml object
2var signedXml = certificate.signXml({
3    algorithm: certificate.HashAlg.SHA256,
4    certId: 'custcertificate1',
5    rootTag: 'infNFe',
6    xmlString: infNFe.getContents()
7});
8 
9// Verifying the XML signature
10certificate.verifyXmlSignature({
11    signedXml: signedXml,
12    rootTag: 'infNFe'
13});

Important Notes

The signing methods disable formatting, which means any line breaks in the XML will not be included in the signature.
This module is only available for use in server scripts, emphasizing its security and operational integrity.

Who This Affects

Developers: Utilizing the N/crypto/certificate module for secure XML processing.
Administrators: Implementing secure transaction processes through SuiteScript.

Key Takeaways

The N/crypto/certificate module facilitates secure XML signing and verification.
It includes essential methods for creating signers and verifiers.
Effective for server-side scripts, enhancing data security through digital signatures.

Frequently Asked Questions (4)

Can the N/crypto/certificate module be used in client scripts?

No, the N/crypto/certificate module is only available for use in server scripts to ensure security and operational integrity.

What algorithms are supported by the N/crypto/certificate module for signing?

The module uses string values from the certificate.HashAlg enum for hash algorithms, such as SHA256, in its signing and verifying methods.

How does the signXml method handle XML formatting?

The signing methods disable formatting, meaning any line breaks in the XML will not be included in the signature. This is crucial for maintaining data integrity in the signature.

What objects does the N/crypto/certificate module provide for signature creation and verification?

The module provides objects such as certificate.SignedXml for signed XML strings, certificate.Signer for creating signatures, and certificate.Verifier for verifying signatures.

N/crypto/certificate Module Features in SuiteScript