trait Crypto extends Object

The crypto module provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.

Annotations
@JSType() @native()
See also

https://nodejs.org/dist/latest-v7.x/docs/api/crypto.html#crypto_crypto

Linear Supertypes
Object, Any, AnyRef, Any
Known Subclasses
Crypto
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Crypto
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def createCipheriv(algorithm: String, key: KeyObject, iv: BufferLike): Cipher
  7. def createCipheriv(algorithm: String, key: KeyObject, iv: String): Cipher
  8. def createCipheriv(algorithm: String, key: KeyObject, iv: BufferLike, options: TransformOptions): Cipher
  9. def createCipheriv(algorithm: String, key: KeyObject, iv: String, options: TransformOptions): Cipher
  10. def createCipheriv(algorithm: String, key: BufferLike, iv: BufferLike): Cipher
  11. def createCipheriv(algorithm: String, key: BufferLike, iv: String, options: TransformOptions): Cipher
  12. def createCipheriv(algorithm: String, key: String, iv: BufferLike): Cipher
  13. def createCipheriv(algorithm: String, key: String, iv: String, options: TransformOptions): Cipher
  14. def createDecipheriv(algorithm: String, key: KeyObject, iv: BufferLike): Decipher
  15. def createDecipheriv(algorithm: String, key: KeyObject, iv: String): Decipher
  16. def createDecipheriv(algorithm: String, key: KeyObject, iv: BufferLike, options: TransformOptions): Decipher
  17. def createDecipheriv(algorithm: String, key: KeyObject, iv: String, options: TransformOptions): Decipher
  18. def createDecipheriv(algorithm: String, key: BufferLike, iv: BufferLike): Decipher
  19. def createDecipheriv(algorithm: String, key: BufferLike, iv: String): Decipher
  20. def createDecipheriv(algorithm: String, key: String, iv: BufferLike, options: TransformOptions): Decipher
  21. def createDecipheriv(algorithm: String, key: String, iv: String, options: TransformOptions): Decipher
  22. def createDiffieHellman(primeLength: Int, generator: Int): DiffieHellman
  23. def createDiffieHellman(prime: BufferLike, generator: BufferLike): DiffieHellman
  24. def createDiffieHellman(prime: BufferLike, generator: Int): DiffieHellman
  25. def createDiffieHellman(prime: BufferLike, generator: String, generatorEncoding: String): DiffieHellman
  26. def createDiffieHellman(prime: String, primeEncoding: String, generator: String, generatorEncoding: String): DiffieHellman
  27. def createDiffieHellman(prime: String, primeEncoding: String, generator: BufferLike): DiffieHellman
  28. def createDiffieHellman(prime: String, primeEncoding: String, generator: Int): DiffieHellman
  29. def createDiffieHellmanGroup(name: String): DiffieHellman
  30. def createECDH(curveName: String): ECDH
  31. def createHash(algorithm: String): Hash
  32. def createHash(algorithm: String, options: CreateHashOptions): Hash

    Creates and returns a Hash object that can be used to generate hash digests using the given algorithm.

    Creates and returns a Hash object that can be used to generate hash digests using the given algorithm.

    The algorithm is dependent on the available algorithms supported by the version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc. On recent releases of OpenSSL, openssl list-message-digest-algorithms will display the available digest algorithms.

    algorithm

    the given algorithm (e.g. 'sha256', 'sha512')

  33. def createHmac(algorithm: String, key: KeyObject): Hmac
  34. def createHmac(algorithm: String, key: KeyObject, options: TransformOptions): Hmac
  35. def createHmac(algorithm: String, key: BufferLike): Hmac
  36. def createHmac(algorithm: String, key: String): Hmac
  37. def createHmac(algorithm: String, key: BufferLike, options: TransformOptions): Hmac
  38. def createHmac(algorithm: String, key: String, options: TransformOptions): Hmac

    Creates and returns an Hmac object that uses the given algorithm and key.

    Creates and returns an Hmac object that uses the given algorithm and key.

    The algorithm is dependent on the available algorithms supported by the version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc. On recent releases of OpenSSL, openssl list-message-digest-algorithms will display the available digest algorithms.

    algorithm

    the given algorithm (e.g. 'sha256', 'sha512')

    key

    The key is the HMAC key used to generate the cryptographic HMAC hash.

  39. def createPrivateKey(key: CreatePrivateKeyOptions): KeyObject
  40. def createPrivateKey(key: Buffer): KeyObject
  41. def createPrivateKey(key: String): KeyObject
  42. def createPublicKey(key: CreatePublicKeyOptions): KeyObject
  43. def createPublicKey(key: KeyObject): KeyObject
  44. def createPublicKey(key: Buffer): KeyObject
  45. def createPublicKey(key: String): KeyObject
  46. def createSecretKey(key: Buffer): KeyObject
  47. def createSign(algorithm: String): Sign
  48. def createSign(algorithm: String, options: WritableOptions): Sign

    Creates and returns a Sign object that uses the given algorithm.

    Creates and returns a Sign object that uses the given algorithm. On recent OpenSSL releases, openssl list-public-key-algorithms will display the available signing algorithms. One example is 'RSA-SHA256'.

    algorithm

    the given algorithm (e.g. 'RSA-SHA256')

  49. def createVerify(algorithm: String): Verify
  50. def createVerify(algorithm: String, options: WritableOptions): Verify

    Creates and returns a Verify object that uses the given algorithm.

    Creates and returns a Verify object that uses the given algorithm. On recent OpenSSL releases, openssl list-public-key-algorithms will display the available signing algorithms. One example is 'RSA-SHA256'.

    algorithm

    the given algorithm (e.g. 'RSA-SHA256')

  51. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  53. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  54. def generateKeyPair(type: String, options: GenerateKeyPairOptions, callback: Callback2[|[|[String, Buffer], KeyObject], |[|[String, Buffer], KeyObject]]): Unit
  55. def generateKeyPairSync(type: String, options: GenerateKeyPairOptions): KeyPair
  56. def getCiphers(): Array[String]

    Returns an array with the names of the supported cipher algorithms.

    Returns an array with the names of the supported cipher algorithms.

    returns

    the names of the supported cipher algorithms. // ['aes-128-cbc', 'aes-128-ccm', ...]

  57. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. def getCurves(): Array[String]
  59. def getDiffieHellman(groupName: String): DiffieHellmanGroup
  60. def getFips(): Boolean
  61. def getHashes(): Array[String]
  62. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  63. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  64. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  65. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  66. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. def pbkdf2(password: BufferLike, salt: BufferLike, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  70. def pbkdf2(password: BufferLike, salt: String, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  71. def pbkdf2(password: String, salt: BufferLike, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  72. def pbkdf2(password: String, salt: String, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  73. def pbkdf2Sync(password: BufferLike, salt: BufferLike, iterations: Int, keylen: Int, digest: String): Buffer
  74. def pbkdf2Sync(password: BufferLike, salt: String, iterations: Int, keylen: Int, digest: String): Buffer
  75. def pbkdf2Sync(password: String, salt: BufferLike, iterations: Int, keylen: Int, digest: String): Buffer
  76. def pbkdf2Sync(password: String, salt: String, iterations: Int, keylen: Int, digest: String): Buffer

    Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2) implementation.

    Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2) implementation. A selected HMAC digest algorithm specified by digest is applied to derive a key of the requested byte length (keylen) from the password, salt and iterations.

    If an error occurs an Error will be thrown, otherwise the derived key will be returned as a Buffer.

    The iterations argument must be a number set as high as possible. The higher the number of iterations, the more secure the derived key will be, but will take a longer amount of time to complete.

    The salt should also be as unique as possible. It is recommended that the salts are random and their lengths are greater than 16 bytes. See NIST SP 800-132 for details.

    (Doc source: https://nodejs.org/api/crypto.html#crypto_crypto_pbkdf2sync_password_salt_iterations_keylen_digest)

  77. def privateDecrypt(privateKey: PrivateDecryptKeyObject, buffer: BufferLike): Buffer
  78. def privateDecrypt(privateKey: Buffer, buffer: BufferLike): Buffer
  79. def privateDecrypt(privateKey: String, buffer: BufferLike): Buffer
  80. def privateEncrypt(privateKey: PrivateEncryptKeyObject, buffer: BufferLike): Buffer
  81. def privateEncrypt(privateKey: Buffer, buffer: BufferLike): Buffer
  82. def privateEncrypt(privateKey: String, buffer: BufferLike): Buffer
  83. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  84. def publicDecrypt(key: PublicDecryptKeyObject, buffer: BufferLike): Buffer
  85. def publicDecrypt(key: Buffer, buffer: BufferLike): Buffer
  86. def publicDecrypt(key: String, buffer: BufferLike): Buffer
  87. def publicEncrypt(key: PublicEncryptKeyObject, buffer: BufferLike): Buffer
  88. def publicEncrypt(key: Buffer, buffer: BufferLike): Buffer
  89. def publicEncrypt(key: String, buffer: BufferLike): Buffer
  90. def randomBytes(size: Int, callback: Callback1[Buffer]): Unit
  91. def randomBytes(size: Int): Buffer
  92. def randomFill[T <: TypedArray[_, T]](buffer: T, callback: Callback1[T]): T
  93. def randomFill[T <: TypedArray[_, T]](buffer: T, offset: Int, callback: Callback1[T]): T
  94. def randomFill[T <: TypedArray[_, T]](buffer: T, offset: Int, size: Int, callback: Callback1[T]): T
  95. def randomFill(buffer: DataView, callback: Callback1[DataView]): DataView
  96. def randomFill(buffer: DataView, offset: Int, callback: Callback1[DataView]): DataView
  97. def randomFill(buffer: DataView, offset: Int, size: Int, callback: Callback1[DataView]): DataView
  98. def randomFill(buffer: Buffer, callback: Callback1[Buffer]): Buffer
  99. def randomFill(buffer: Buffer, offset: Int, callback: Callback1[Buffer]): Buffer
  100. def randomFill(buffer: Buffer, offset: Int, size: Int, callback: Callback1[Buffer]): Buffer
  101. def randomFillSync[T <: TypedArray[_, T]](buffer: T): T
  102. def randomFillSync[T <: TypedArray[_, T]](buffer: T, offset: Int): T
  103. def randomFillSync[T <: TypedArray[_, T]](buffer: T, offset: Int, size: Int): T
  104. def randomFillSync(buffer: DataView): DataView
  105. def randomFillSync(buffer: DataView, offset: Int): DataView
  106. def randomFillSync(buffer: DataView, offset: Int, size: Int): DataView
  107. def randomFillSync(buffer: Buffer): Buffer
  108. def randomFillSync(buffer: Buffer, offset: Int): Buffer
  109. def randomFillSync(buffer: Buffer, offset: Int, size: Int): Buffer
  110. def randomInt(min: Int, max: Int, callback: Callback1[Int]): Unit
  111. def randomInt(min: Int, max: Int): Int
  112. def randomInt(max: Int, callback: Callback1[Int]): Unit
  113. def randomInt(max: Int): Int
  114. def scrypt(password: BufferLike, salt: BufferLike, keylen: Int, callback: Callback1[Buffer]): Unit
  115. def scrypt(password: BufferLike, salt: String, keylen: Int, callback: Callback1[Buffer]): Unit
  116. def scrypt(password: String, salt: BufferLike, keylen: Int, callback: Callback1[Buffer]): Unit
  117. def scrypt(password: String, salt: String, keylen: Int, callback: Callback1[Buffer]): Unit
  118. def scrypt(password: BufferLike, salt: BufferLike, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  119. def scrypt(password: BufferLike, salt: String, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  120. def scrypt(password: String, salt: BufferLike, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  121. def scrypt(password: String, salt: String, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  122. def scryptSync(password: BufferLike, salt: BufferLike, keylen: Int): Buffer
  123. def scryptSync(password: BufferLike, salt: String, keylen: Int): Buffer
  124. def scryptSync(password: String, salt: BufferLike, keylen: Int): Buffer
  125. def scryptSync(password: String, salt: String, keylen: Int): Buffer
  126. def scryptSync(password: BufferLike, salt: BufferLike, keylen: Int, options: ScryptOptions): Buffer
  127. def scryptSync(password: BufferLike, salt: String, keylen: Int, options: ScryptOptions): Buffer
  128. def scryptSync(password: String, salt: BufferLike, keylen: Int, options: ScryptOptions): Buffer
  129. def scryptSync(password: String, salt: String, keylen: Int, options: ScryptOptions): Buffer
  130. def setEngine(engine: String): Unit
  131. def setEngine(engine: String, fips: Int): Unit
  132. def setFips(enable: Boolean): Unit
  133. def sign(data: BufferLike, key: KeyObject): Buffer
  134. def sign(data: BufferLike, key: Buffer): Buffer
  135. def sign(data: BufferLike, key: String): Buffer
  136. def sign(algorithm: String, data: BufferLike, key: KeyObject): Buffer
  137. def sign(algorithm: String, data: BufferLike, key: Buffer): Buffer
  138. def sign(algorithm: String, data: BufferLike, key: String): Buffer
  139. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  140. def timingSafeEqual(a: BufferLike, b: BufferLike): Boolean
  141. def toLocaleString(): String
    Definition Classes
    Object
  142. def toString(): String
    Definition Classes
    AnyRef → Any
  143. def valueOf(): Any
    Definition Classes
    Object
  144. def verify(data: BufferLike, key: KeyObject): Boolean
  145. def verify(data: BufferLike, key: Buffer): Boolean
  146. def verify(data: BufferLike, key: String): Boolean
  147. def verify(algorithm: String, data: BufferLike, key: KeyObject): Boolean
  148. def verify(algorithm: String, data: BufferLike, key: Buffer): Boolean
  149. def verify(algorithm: String, data: BufferLike, key: String): Boolean
  150. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  151. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  152. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. val DEFAULT_ENCODING: String

    The default encoding to use for functions that can take either strings or buffers.

    The default encoding to use for functions that can take either strings or buffers. The default value is 'buffer', which makes methods default to Buffer objects.

    The crypto.DEFAULT_ENCODING mechanism is provided for backwards compatibility with legacy programs that expect 'binary' to be the default encoding.

    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v10.0) New applications should expect the default to be 'buffer'.

  2. def createCipher(algorithm: String, password: String): Cipher
    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v10.0) Use crypto.createCipheriv() instead.

  3. def createCipher(algorithm: String, password: Buffer): Cipher

    Creates and returns a Cipher object that uses the given algorithm and password.

    Creates and returns a Cipher object that uses the given algorithm and password.

    algorithm

    The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On recent OpenSSL releases, openssl list-cipher-algorithms will display the available cipher algorithms.

    password

    The password is used to derive the cipher key and initialization vector (IV). The value must be either a 'binary' encoded string or a Buffer.

    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v10.0) Use crypto.createCipheriv() instead.

    Example:

    1. crypto.createCipher(algorithm, password)

  4. def createDecipher(algorithm: String, password: String): Decipher
    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v10.0) Use crypto.createDecipheriv() instead.

  5. def createDecipher(algorithm: String, password: Buffer): Decipher

    Creates and returns a Decipher object that uses the given algorithm and password (key).

    Creates and returns a Decipher object that uses the given algorithm and password (key). The implementation of crypto.createDecipher() 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 pbkdf2 instead of EVP_BytesToKey it is recommended that developers derive a key and IV on their own using crypto.pbkdf2() and to use crypto.createDecipheriv() to create the Decipher object.

    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v10.0) Use crypto.createDecipheriv() instead.

    Example:

    1. crypto.createDecipher(algorithm, password)

  6. val fips: Boolean

    Property for checking and controlling whether a FIPS compliant crypto provider is currently in use.

    Property for checking and controlling whether a FIPS compliant crypto provider is currently in use. Setting to true requires a FIPS build of Node.js.

    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v10.0) Please use crypto.setFips() and crypto.getFips() instead.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped