N/crypto/certificate Module

Use the N/crypto/certificate module to sign XML documents or strings with digital certificates using asymmetric cryptography. You can also use this module to create signer and verifier objects and verify signed documents.

N/crypto/certificate Module Script Samples

In This Help Topic

• N/crypto/certificate Module Members

• SignedXml Object Members

• Signer Object Members

• Verifier Object Members

N/crypto/certificate Module Members

Member Type	Name	Return Type/Value Type	Supported Script Types	Description
Object	certificate.SignedXml	Object	Server scripts	Encapsulates an XML string that has been digitally signed. Use certificate.signXml(options) to create this object.
	certificate.Signer	Object	Server scripts	Encapsulates a created signature (signer) for plain strings. Use certificate.createSigner(options) to create this object.
	certificate.Verifier	Object	Server scripts	Encapsulates a created verifier for verifying plain string signatures. Use certificate.createVerifier(options) to create this object.
Method	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. Returns the certificate.SignedXml as a string. Note: Formatting, such as line breaks, is disabled in signatures.
	certificate.verifyXmlSignature(options)	void	Server scripts	Verifies the signature in the SignedXml.asFile() file.
Enum	certificate.HashAlg	enum	Server scripts	Holds the string values for hash algorithm types. Use this enum to set the option.algorithm property values for the certificate.createSigner(options), certificate.createVerifier(options), certificate.signXml(options) methods.

SignedXml Object Members

The following members are called on the certificate.SignedXml object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Method	SignedXml.asFile()	file.File	Server scripts	Returns the signed XML as a file object.
	SignedXml.asString()	string	Server scripts	Returns the signed XML as a string.
	SignedXml.asXml()	xml.Document	Server scripts	Returns the signed XML as an XML document. You can use the N/xml Module with this document to access elements and attributes in the XML.

Signer Object Members

The following members are called on the certificate.Signer object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Method	Signer.sign(options)	void	Server scripts	Signs the string and returns the signature.
	Signer.update(options)	void	Server scripts	Updates the input string to be signed. The string can be encoded.

Verifier Object Members

The following members are called on the certificate.Verifier object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Method	Verifier.update(options)	void	Server scripts	Updates the string to be verified against specified certificate.
	Verifier.verify(options)	void	Server scripts	Verifies the string against a provided signature using specified certificate.

Related Topics

• SignedXml.asFile()
• SignedXml.asString()
• SignedXml.asXml()

General Notices