crypto.createCipher(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Creates a new crypto.Cipher object. Note: The blockCipherMode is automatically set to CBC.
Returns	A crypto.Cipher object
Supported Script Types	Server scripts For additional information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/crypto Module
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.algorithm	string	required	The encryption algorithm. Use the crypto.EncryptionAlg enum to set the value.	2015.2
options.key	object	required	The crypto.SecretKey object. Note: When using the crypto.SecretKey object for an AES algorithm, the length of the text (secret key) that is used to generate the GUID must be 16, 24, or 32 characters.	2015.2
options.padding	string	optional	The padding for the cipher text. Use the crypto.Padding enum to set the value. The default value is crypto.Padding.PKCS5Padding.	2015.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/crypto Module Script Samples.

          //Add additional code 
...
var cipher = crypto.createCipher({
    algorithm: crypto.EncryptionAlg.AES,
    key: sKey,
    padding: crypto.Padding.PKCS5Padding
});
...
//Add additional code 

        

Related Topics

N/crypto Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices