Skip to content

Latest commit

 

History

History
40 lines (38 loc) · 4.61 KB

crypto.md

File metadata and controls

40 lines (38 loc) · 4.61 KB
Raw

Cryptographic methods and fields

The following methods are defined in the built-in crypto class:

  • crypto.bcrypt(password, [cost]), which returns a string of the bcrypt hash of the specified password as a string with the specified cost as an integer. If the cost is omitted, the resulting bcrypt hash will have a cost of 10
    • If the cost is less than 4, the cost is set to 10
    • If the cost is greater than 31, a runtime error is thrown
    • If the password is larger than 72 bytes, a runtime error is thrown
  • crypto.bcryptVerify(password, hash), which takes in the specified password and bcrypt hash as strings and returns true if the password matches the hash and false otherwise
  • crypto.md5([data]), which returns a hash object that computes the MD5 hash of data that is passed into it. If the data parameter is specified, which must be a buffer or string, the hash object is initialized with the specified data passed into it
    • Warning: MD5 is cryptographically broken and is unsuitable for security purposes
  • crypto.md5sum(data), which returns a string that is the hexadecimal representation of the MD5 hash of the specified data, which is either a buffer or string
    • Warning: MD5 is cryptographically broken and is unsuitable for security purposes
  • crypto.sha1([data]), which returns a hash object that computes the SHA-1 hash of data that is passed into it. If the data parameter is specified, which must be a buffer or string, the hash object is initialized with the specified data passed into it
    • Warning: SHA-1 is cryptographically broken and is unsuitable for security purposes
  • crypto.sha1sum(data), which returns a string that is the hexadecimal representation of the SHA-1 hash of the specified data, which is either a buffer or string
    • Warning: SHA-1 is cryptographically broken and is unsuitable for security purposes
  • crypto.sha224([data]), which returns a hash object that computes the SHA-224 hash of data that is passed into it. If the data parameter is specified, which must be a buffer or string, the hash object is initialized with the specified data passed into it
  • crypto.sha224sum(data), which returns a string that is the hexadecimal representation of the SHA-224 hash of the specified data, which is either a buffer or string
  • crypto.sha256([data]), which returns a hash object that computes the SHA-256 hash of data that is passed into it. If the data parameter is specified, which must be a buffer or string, the hash object is initialized with the specified data passed into it
  • crypto.sha256sum(data), which returns a string that is the hexadecimal representation of the SHA-256 hash of the specified data, which is either a buffer or string
  • crypto.sha384([data]), which returns a hash object that computes the SHA-384 hash of data that is passed into it. If the data parameter is specified, which must be a buffer or string, the hash object is initialized with the specified data passed into it
  • crypto.sha384sum(data), which returns a string that is the hexadecimal representation of the SHA-384 hash of the specified data, which is either a buffer or string
  • crypto.sha512([data]), which returns a hash object that computes the SHA-512 hash of data that is passed into it. If the data parameter is specified, which must be a buffer or string, the hash object is initialized with the specified data passed into it
  • crypto.sha512sum(data), which returns a string that is the hexadecimal representation of the SHA-512 hash of the specified data, which is either a buffer or string

Hash objects have the following methods and fields associated with them:

  • hash.blockSize, which is the block size of the hash object's hash algorithm as an integer
  • hash.digest(), which returns a buffer of the current hash based on the hash object's hash algorithm and the current data in the hash object
  • hash.hex(), which is an alias for hash.hexDigest
  • hash.hexDigest(), which returns a string that is the hexadecimal representation of the current hash based on the hash object's hash algorithm and the current data in the hash object
  • hash.reset(), which clears all the current data from the hash object, resetting it to its initial state
  • hash.size, which is the number of bytes the final hash will have as an integer
  • hash.type, which is the type of the hash object's hash algorithm as a string, with the following values:
    • md5 for MD5
    • sha1 for SHA-1
    • sha224 for SHA-224
    • sha256 for SHA-256
    • sha384 for SHA-384
    • sha512 for SHA-512
  • hash.update(data), which updates the hash object with the specified data, which must be a buffer or string