stream.transform options
since v10.0.0 use createCipheriv()
Optional options: "crypto".CipherGCMOptionssince v10.0.0 use createCipheriv()
Optional options: "stream".TransformOptionsCreates and returns a Cipher object that uses the given algorithm andpassword.
The options argument controls stream behavior and is optional except when a
cipher in CCM or OCB mode (e.g. 'aes-128-ccm') is used. In that case, theauthTagLength option is required and specifies the length of the
authentication tag in bytes, see CCM mode. In GCM mode, the authTagLengthoption is not required but can be used to set the length of the authentication
tag that will be returned by getAuthTag() and defaults to 16 bytes.
For chacha20-poly1305, the authTagLength option defaults to 16 bytes.
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list -cipher-algorithms will
display the available cipher algorithms.
The password is used to derive the cipher key and initialization vector (IV).
The value must be either a 'latin1' encoded string, a Buffer, aTypedArray, or a DataView.
The implementation of crypto.createCipher() derives keys using the OpenSSL
function EVP_BytesToKey with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.
In line with OpenSSL's recommendation to use a more modern algorithm instead of EVP_BytesToKey it is recommended that
developers derive a key and IV on
their own using scrypt and to use createCipheriv to create the Cipher object. Users should not use ciphers with counter mode
(e.g. CTR, GCM, or CCM) in crypto.createCipher(). A warning is emitted when
they are used in order to avoid the risk of IV reuse that causes
vulnerabilities. For the case when IV is reused in GCM, see Nonce-Disrespecting Adversaries for details.
Since v10.0.0 - Use createCipheriv instead.
stream.transform options
since v10.0.0 use createCipheriv()
Optional options: "crypto".CipherGCMOptionssince v10.0.0 use createCipheriv()
Optional options: "stream".TransformOptionsGenerated using TypeDoc
Creates and returns a
Cipherobject that uses the givenalgorithmandpassword.The
optionsargument controls stream behavior and is optional except when a cipher in CCM or OCB mode (e.g.'aes-128-ccm') is used. In that case, theauthTagLengthoption is required and specifies the length of the authentication tag in bytes, seeCCM mode. In GCM mode, theauthTagLengthoption is not required but can be used to set the length of the authentication tag that will be returned bygetAuthTag()and defaults to 16 bytes. Forchacha20-poly1305, theauthTagLengthoption defaults to 16 bytes.The
algorithmis dependent on OpenSSL, examples are'aes192', etc. On recent OpenSSL releases,openssl list -cipher-algorithmswill display the available cipher algorithms.The
passwordis used to derive the cipher key and initialization vector (IV). The value must be either a'latin1'encoded string, aBuffer, aTypedArray, or aDataView.The implementation of
crypto.createCipher()derives keys using the OpenSSL functionEVP_BytesToKeywith the digest algorithm set to MD5, one iteration, and no salt. The lack of salt allows dictionary attacks as the same password always creates the same key. The low iteration count and non-cryptographically secure hash algorithm allow passwords to be tested very rapidly.In line with OpenSSL's recommendation to use a more modern algorithm instead of
EVP_BytesToKeyit is recommended that developers derive a key and IV on their own using scrypt and to use createCipheriv to create theCipherobject. Users should not use ciphers with counter mode (e.g. CTR, GCM, or CCM) incrypto.createCipher(). A warning is emitted when they are used in order to avoid the risk of IV reuse that causes vulnerabilities. For the case when IV is reused in GCM, see Nonce-Disrespecting Adversaries for details.Deprecated
Since v10.0.0 - Use createCipheriv instead.