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
@RawJSType() @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 createDiffieHellman(primeLength: Int, generator: |[|[Int, String], BufferLike]): DiffieHellman
  7. def createDiffieHellman(prime: BufferLike, generator: |[Int, BufferLike]): DiffieHellman
  8. def createDiffieHellman(prime: BufferLike, generator: String, generatorEncoding: String): DiffieHellman
  9. def createDiffieHellman(prime: String, primeEncoding: String, generator: String, generatorEncoding: String): DiffieHellman
  10. def createDiffieHellman(prime: String, primeEncoding: String, generator: |[Int, BufferLike]): DiffieHellman
  11. def createDiffieHellmanGroup(name: String): DiffieHellman
  12. def createECDH(curveName: String): ECDH
  13. def createHash(algorithm: String, options: CreateHashOptions = js.native): Hash
  14. 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')

  15. def createHmac(algorithm: String, key: |[String, BufferLike], options: TransformOptions = js.native): 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.

  16. def createSign(algorithm: String, options: WritableOptions = js.native): 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')

  17. def createVerify(algorithm: String, options: WritableOptions = js.native): 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')

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. 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', ...]

  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def getCurves(): Array[String]
  23. def getDiffieHellman(groupName: String): DiffieHellmanGroup
  24. def getHashes(): Array[String]
  25. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def pbkdf2(password: |[String, BufferLike], salt: |[String, BufferLike], iterations: Int, keylen: Int, digest: String, callback: Callback1[Buffer]): Buffer
  33. def pbkdf2Sync(password: |[String, BufferLike], salt: |[String, BufferLike], 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)

  34. def privateDecrypt(privateKey: |[String, Buffer], buffer: BufferLike): Buffer
  35. def privateEncrypt(privateKey: |[String, Buffer], buffer: BufferLike): Buffer
  36. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  37. def publicDecrypt(key: |[String, Buffer], buffer: BufferLike): Buffer
  38. def publicEncrypt(key: |[String, Buffer], buffer: BufferLike): Buffer
  39. def randomBytes(size: Int, callback: Callback1[Buffer]): Unit
  40. def randomBytes(size: Int): Buffer
  41. def randomFill(buffer: Buffer, callback: Callback1[Buffer]): Buffer
  42. def randomFill(buffer: Buffer, offset: Int, callback: Callback1[Buffer]): Buffer
  43. def randomFill(buffer: Buffer, offset: Int, size: Int, callback: Callback1[Buffer]): Buffer
  44. def randomFillSync(buffer: Buffer): Buffer
  45. def randomFillSync(buffer: Buffer, offset: Int): Buffer
  46. def randomFillSync(buffer: Buffer, offset: Int, size: Int): Buffer
  47. def setEngine(engine: String, fips: Int = js.native): Unit
  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. def timingSafeEqual(a: BufferLike, b: BufferLike): Boolean
  50. def toLocaleString(): String
    Definition Classes
    Object
  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. def valueOf(): Any
    Definition Classes
    Object
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. 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: |[Buffer, String]): 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)

  3. def createDecipher(algorithm: String, password: |[Buffer, String]): 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)

  4. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  5. 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