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() @HotSpotIntrinsicCandidate()
  6. def createCipheriv(algorithm: String, key: BufferLike, iv: BufferLike): Cipher
  7. def createCipheriv(algorithm: String, key: BufferLike, iv: String, options: TransformOptions): Cipher
  8. def createCipheriv(algorithm: String, key: String, iv: BufferLike): Cipher
  9. def createCipheriv(algorithm: String, key: String, iv: String, options: TransformOptions): Cipher
  10. def createDecipheriv(algorithm: String, key: KeyObject, iv: BufferLike): Decipher
  11. def createDecipheriv(algorithm: String, key: KeyObject, iv: String): Decipher
  12. def createDecipheriv(algorithm: String, key: KeyObject, iv: BufferLike, options: TransformOptions): Decipher
  13. def createDecipheriv(algorithm: String, key: KeyObject, iv: String, options: TransformOptions): Decipher
  14. def createDecipheriv(algorithm: String, key: BufferLike, iv: BufferLike): Decipher
  15. def createDecipheriv(algorithm: String, key: BufferLike, iv: String): Decipher
  16. def createDecipheriv(algorithm: String, key: String, iv: BufferLike, options: TransformOptions): Decipher
  17. def createDecipheriv(algorithm: String, key: String, iv: String, options: TransformOptions): Decipher
  18. def createDiffieHellman(primeLength: Int, generator: Int): DiffieHellman
  19. def createDiffieHellman(prime: BufferLike, generator: BufferLike): DiffieHellman
  20. def createDiffieHellman(prime: BufferLike, generator: Int): DiffieHellman
  21. def createDiffieHellman(prime: BufferLike, generator: String, generatorEncoding: String): DiffieHellman
  22. def createDiffieHellman(prime: String, primeEncoding: String, generator: String, generatorEncoding: String): DiffieHellman
  23. def createDiffieHellman(prime: String, primeEncoding: String, generator: BufferLike): DiffieHellman
  24. def createDiffieHellman(prime: String, primeEncoding: String, generator: Int): DiffieHellman
  25. def createDiffieHellmanGroup(name: String): DiffieHellman
  26. def createECDH(curveName: String): ECDH
  27. def createHash(algorithm: String): Hash
  28. def createHash(algorithm: String, options: CreateHashOptions): Hash
  29. def createHmac(algorithm: String, key: BufferLike): Hmac
  30. def createHmac(algorithm: String, key: String): Hmac
  31. def createHmac(algorithm: String, key: BufferLike, options: TransformOptions): Hmac
  32. 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.

  33. def createSign(algorithm: String): Sign
  34. 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')

  35. def createVerify(algorithm: String): Verify
  36. 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')

  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  39. def generateKeyPair(type: String, options: GenerateKeyPairOptions, callback: Callback2[|[|[String, Buffer], KeyObject], |[|[String, Buffer], KeyObject]]): Unit
  40. def generateKeyPairSync(type: String, options: GenerateKeyPairOptions): KeyPair
  41. 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', ...]

  42. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. def getCurves(): Array[String]
  44. def getDiffieHellman(groupName: String): DiffieHellmanGroup
  45. def getFips(): Boolean
  46. def getHashes(): Array[String]
  47. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  48. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. def pbkdf2(password: BufferLike, salt: BufferLike, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  55. def pbkdf2(password: BufferLike, salt: String, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  56. def pbkdf2(password: String, salt: BufferLike, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  57. def pbkdf2(password: String, salt: String, iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  58. def pbkdf2Sync(password: BufferLike, salt: BufferLike, iterations: Int, keylen: Int, digest: String): Buffer
  59. def pbkdf2Sync(password: BufferLike, salt: String, iterations: Int, keylen: Int, digest: String): Buffer
  60. def pbkdf2Sync(password: String, salt: BufferLike, iterations: Int, keylen: Int, digest: String): Buffer
  61. 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)

  62. def privateDecrypt(privateKey: Buffer, buffer: BufferLike): Buffer
  63. def privateDecrypt(privateKey: String, buffer: BufferLike): Buffer
  64. def privateEncrypt(privateKey: Buffer, buffer: BufferLike): Buffer
  65. def privateEncrypt(privateKey: String, buffer: BufferLike): Buffer
  66. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  67. def publicDecrypt(key: Buffer, buffer: BufferLike): Buffer
  68. def publicDecrypt(key: String, buffer: BufferLike): Buffer
  69. def publicEncrypt(key: Buffer, buffer: BufferLike): Buffer
  70. def publicEncrypt(key: String, buffer: BufferLike): Buffer
  71. def randomBytes(size: Int, callback: Callback1[Buffer]): Unit
  72. def randomBytes(size: Int): Buffer
  73. def randomFill[T <: TypedArray[_, T]](buffer: T, callback: Callback1[T]): T
  74. def randomFill[T <: TypedArray[_, T]](buffer: T, offset: Int, callback: Callback1[T]): T
  75. def randomFill[T <: TypedArray[_, T]](buffer: T, offset: Int, size: Int, callback: Callback1[T]): T
  76. def randomFill(buffer: DataView, callback: Callback1[DataView]): DataView
  77. def randomFill(buffer: DataView, offset: Int, callback: Callback1[DataView]): DataView
  78. def randomFill(buffer: DataView, offset: Int, size: Int, callback: Callback1[DataView]): DataView
  79. def randomFill(buffer: Buffer, callback: Callback1[Buffer]): Buffer
  80. def randomFill(buffer: Buffer, offset: Int, callback: Callback1[Buffer]): Buffer
  81. def randomFill(buffer: Buffer, offset: Int, size: Int, callback: Callback1[Buffer]): Buffer
  82. def randomFillSync[T <: TypedArray[_, T]](buffer: T): T
  83. def randomFillSync[T <: TypedArray[_, T]](buffer: T, offset: Int): T
  84. def randomFillSync[T <: TypedArray[_, T]](buffer: T, offset: Int, size: Int): T
  85. def randomFillSync(buffer: DataView): DataView
  86. def randomFillSync(buffer: DataView, offset: Int): DataView
  87. def randomFillSync(buffer: DataView, offset: Int, size: Int): DataView
  88. def randomFillSync(buffer: Buffer): Buffer
  89. def randomFillSync(buffer: Buffer, offset: Int): Buffer
  90. def randomFillSync(buffer: Buffer, offset: Int, size: Int): Buffer
  91. def scrypt(password: BufferLike, salt: BufferLike, keylen: Int, callback: Callback1[Buffer]): Unit
  92. def scrypt(password: BufferLike, salt: String, keylen: Int, callback: Callback1[Buffer]): Unit
  93. def scrypt(password: String, salt: BufferLike, keylen: Int, callback: Callback1[Buffer]): Unit
  94. def scrypt(password: String, salt: String, keylen: Int, callback: Callback1[Buffer]): Unit
  95. def scrypt(password: BufferLike, salt: BufferLike, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  96. def scrypt(password: BufferLike, salt: String, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  97. def scrypt(password: String, salt: BufferLike, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  98. def scrypt(password: String, salt: String, keylen: Int, options: ScryptOptions, callback: Callback1[Buffer]): Unit
  99. def scryptSync(password: BufferLike, salt: BufferLike, keylen: Int): Buffer
  100. def scryptSync(password: BufferLike, salt: String, keylen: Int): Buffer
  101. def scryptSync(password: String, salt: BufferLike, keylen: Int): Buffer
  102. def scryptSync(password: String, salt: String, keylen: Int): Buffer
  103. def scryptSync(password: BufferLike, salt: BufferLike, keylen: Int, options: ScryptOptions): Buffer
  104. def scryptSync(password: BufferLike, salt: String, keylen: Int, options: ScryptOptions): Buffer
  105. def scryptSync(password: String, salt: BufferLike, keylen: Int, options: ScryptOptions): Buffer
  106. def scryptSync(password: String, salt: String, keylen: Int, options: ScryptOptions): Buffer
  107. def setEngine(engine: String): Unit
  108. def setEngine(engine: String, fips: Int): Unit
  109. def setFips(enable: Boolean): Unit
  110. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  111. def timingSafeEqual(a: BufferLike, b: BufferLike): Boolean
  112. def toLocaleString(): String
    Definition Classes
    Object
  113. def toString(): String
    Definition Classes
    AnyRef → Any
  114. def valueOf(): Any
    Definition Classes
    Object
  115. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  116. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  117. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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. def createHash(algorithm: String, options: TransformOptions): 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')

    Annotations
    @deprecated
    Deprecated

    (Since version v0.12.0) Use CreateHashOptions instead.

  7. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  8. 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