diff options
Diffstat (limited to 'node_modules/sha.js/README.md')
-rw-r--r-- | node_modules/sha.js/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/node_modules/sha.js/README.md b/node_modules/sha.js/README.md new file mode 100644 index 0000000..1cc3db5 --- /dev/null +++ b/node_modules/sha.js/README.md @@ -0,0 +1,44 @@ +# sha.js +[](https://www.npmjs.org/package/sha.js) +[](https://travis-ci.org/crypto-browserify/sha.js) +[](https://david-dm.org/crypto-browserify/sha.js#info=dependencies) + +[](https://github.com/feross/standard) + +Node style `SHA` on pure JavaScript. + +```js +var shajs = require('sha.js') + +console.log(shajs('sha256').update('42').digest('hex')) +// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049 +console.log(new shajs.sha256().update('42').digest('hex')) +// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049 + +var sha256stream = shajs('sha256') +sha256stream.end('42') +console.log(sha256stream.read().toString('hex')) +// => 73475cb40a568e8da8a045ced110137e159f890ac4da883b6b17dc651b3a8049 +``` + +## supported hashes +`sha.js` currently implements: + + - SHA (SHA-0) -- **legacy, do not use in new systems** + - SHA-1 -- **legacy, do not use in new systems** + - SHA-224 + - SHA-256 + - SHA-384 + - SHA-512 + + +## Not an actual stream +Note, this doesn't actually implement a stream, but wrapping this in a stream is trivial. +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). + + +## Acknowledgements +This work is derived from Paul Johnston's [A JavaScript implementation of the Secure Hash Algorithm](http://pajhome.org.uk/crypt/md5/sha1.html). + + +## LICENSE [MIT](LICENSE) |