You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

44 lines
1.7 KiB

4 years ago
  1. # sha.js
  2. [![NPM Package](https://img.shields.io/npm/v/sha.js.svg?style=flat-square)](https://www.npmjs.org/package/sha.js)
  3. [![Build Status](https://img.shields.io/travis/crypto-browserify/sha.js.svg?branch=master&style=flat-square)](https://travis-ci.org/crypto-browserify/sha.js)
  4. [![Dependency status](https://img.shields.io/david/crypto-browserify/sha.js.svg?style=flat-square)](https://david-dm.org/crypto-browserify/sha.js#info=dependencies)
  5. [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
  6. Node style `SHA` on pure JavaScript.
  7. ```js
  8. var shajs = require('sha.js')
  9. console.log(shajs('sha256').update('42').digest('hex'))
  10. // => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049
  11. console.log(new shajs.sha256().update('42').digest('hex'))
  12. // => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049
  13. var sha256stream = shajs('sha256')
  14. sha256stream.end('42')
  15. console.log(sha256stream.read().toString('hex'))
  16. // => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049
  17. ```
  18. ## supported hashes
  19. `sha.js` currently implements:
  20. - SHA (SHA-0) -- **legacy, do not use in new systems**
  21. - SHA-1 -- **legacy, do not use in new systems**
  22. - SHA-224
  23. - SHA-256
  24. - SHA-384
  25. - SHA-512
  26. ## Not an actual stream
  27. Note, this doesn't actually implement a stream, but wrapping this in a stream is trivial.
  28. It does update incrementally, so you can hash things larger than RAM, as it uses a constant amount of memory (except when using base64 or utf8 encoding, see code comments).
  29. ## Acknowledgements
  30. This work is derived from Paul Johnston's [A JavaScript implementation of the Secure Hash Algorithm](http://pajhome.org.uk/crypt/md5/sha1.html).
  31. ## LICENSE [MIT](LICENSE)