UNPKG

8.41 kBMarkdownView Raw
1# js-sha3
2
3[![Build Status](https://travis-ci.org/emn178/js-sha3.svg?branch=master)](https://travis-ci.org/emn178/js-sha3)
4[![Coverage Status](https://coveralls.io/repos/emn178/js-sha3/badge.svg?branch=master)](https://coveralls.io/r/emn178/js-sha3?branch=master)
5[![NPM](https://nodei.co/npm/js-sha3.png?stars&downloads)](https://nodei.co/npm/js-sha3/)
6
7A simple SHA-3 / Keccak / Shake hash function for JavaScript supports UTF-8 encoding.
8
9## Notice
10* Sha3 methods has been renamed to keccak since v0.2.0. It means that sha3 methods of v0.1.x are equal to keccak methods of v0.2.x and later.
11* `buffer` method is deprecated. This maybe confuse with Buffer in node.js. Please use `arrayBuffer` instead.
12
13## Demo
14[SHA3-512 Online](http://emn178.github.io/online-tools/sha3_512.html)
15[SHA3-384 Online](http://emn178.github.io/online-tools/sha3_384.html)
16[SHA3-256 Online](http://emn178.github.io/online-tools/sha3_256.html)
17[SHA3-224 Online](http://emn178.github.io/online-tools/sha3_224.html)
18[Keccak-512 Online](http://emn178.github.io/online-tools/keccak_512.html)
19[Keccak-384 Online](http://emn178.github.io/online-tools/keccak_384.html)
20[Keccak-256 Online](http://emn178.github.io/online-tools/keccak_256.html)
21[Keccak-224 Online](http://emn178.github.io/online-tools/keccak_224.html)
22[Shake-128 Online](http://emn178.github.io/online-tools/shake_128.html)
23[Shake-256 Online](http://emn178.github.io/online-tools/shake_256.html)
24
25## Download
26[Compress](https://raw.github.com/emn178/js-sha3/master/build/sha3.min.js)
27[Uncompress](https://raw.github.com/emn178/js-sha3/master/src/sha3.js)
28
29## Installation
30You can also install js-sha3 by using Bower.
31
32 bower install js-sha3
33
34For node.js, you can use this command to install:
35
36 npm install js-sha3
37
38## Usage
39You could use like this:
40```JavaScript
41sha3_512('Message to hash');
42sha3_384('Message to hash');
43sha3_256('Message to hash');
44sha3_224('Message to hash');
45keccak_512('Message to hash');
46keccak_384('Message to hash');
47keccak_256('Message to hash');
48keccak_224('Message to hash');
49shake_128('Message to hash', 256);
50shake_256('Message to hash', 512);
51
52// Support ArrayBuffer output
53var buffer = keccak_224.buffer('Message to hash');
54
55// Support Array output
56var buffer = keccak_224.array('Message to hash');
57
58// update hash
59sha3_512.update('Message ').update('to ').update('hash').hex();
60// specify shake output bits at first update
61shake_128.update('Message ', 256).update('to ').update('hash').hex();
62
63// or to use create
64var hash = sha3_512.create();
65hash.update('...');
66hash.update('...');
67hash.hex();
68
69// specify shake output bits when creating
70var hash = shake_128.create(256);
71hash.update('...');
72hash.update('...');
73hash.hex();
74```
75If you use node.js, you should require the module first:
76```JavaScript
77sha3_512 = require('js-sha3').sha3_512;
78sha3_384 = require('js-sha3').sha3_384;
79sha3_256 = require('js-sha3').sha3_256;
80sha3_224 = require('js-sha3').sha3_224;
81keccak_512 = require('js-sha3').keccak_512;
82keccak_384 = require('js-sha3').keccak_384;
83keccak_256 = require('js-sha3').keccak_256;
84keccak_224 = require('js-sha3').keccak_224;
85shake_128 = require('js-sha3').shake_128;
86shake_256 = require('js-sha3').shake_256;
87```
88
89## Example
90Code
91```JavaScript
92sha3_512('');
93// a69f73cca23a9ac5c8b567dc185a756e97c982164fe25859e0d1dcc1475c80a615b2123af1f5f94c11e3e9402c3ac558f500199d95b6d3e301758586281dcd26
94
95sha3_512('The quick brown fox jumps over the lazy dog');
96// 01dedd5de4ef14642445ba5f5b97c15e47b9ad931326e4b0727cd94cefc44fff23f07bf543139939b49128caf436dc1bdee54fcb24023a08d9403f9b4bf0d450
97
98sha3_512('The quick brown fox jumps over the lazy dog.');
99// 18f4f4bd419603f95538837003d9d254c26c23765565162247483f65c50303597bc9ce4d289f21d1c2f1f458828e33dc442100331b35e7eb031b5d38ba6460f8
100
101sha3_384('');
102// 0c63a75b845e4f7d01107d852e4c2485c51a50aaaa94fc61995e71bbee983a2ac3713831264adb47fb6bd1e058d5f004
103
104sha3_384('The quick brown fox jumps over the lazy dog');
105// 7063465e08a93bce31cd89d2e3ca8f602498696e253592ed26f07bf7e703cf328581e1471a7ba7ab119b1a9ebdf8be41
106
107sha3_384('The quick brown fox jumps over the lazy dog.');
108// 1a34d81695b622df178bc74df7124fe12fac0f64ba5250b78b99c1273d4b080168e10652894ecad5f1f4d5b965437fb9
109
110sha3_256('');
111// a7ffc6f8bf1ed76651c14756a061d662f580ff4de43b49fa82d80a4b80f8434a
112
113sha3_256('The quick brown fox jumps over the lazy dog');
114// 69070dda01975c8c120c3aada1b282394e7f032fa9cf32f4cb2259a0897dfc04
115
116sha3_256('The quick brown fox jumps over the lazy dog.');
117// a80f839cd4f83f6c3dafc87feae470045e4eb0d366397d5c6ce34ba1739f734d
118
119sha3_224('');
120// 6b4e03423667dbb73b6e15454f0eb1abd4597f9a1b078e3f5b5a6bc7
121
122sha3_224('The quick brown fox jumps over the lazy dog');
123// d15dadceaa4d5d7bb3b48f446421d542e08ad8887305e28d58335795
124
125sha3_224('The quick brown fox jumps over the lazy dog.');
126// 2d0708903833afabdd232a20201176e8b58c5be8a6fe74265ac54db0
127
128keccak_512('');
129// 0eab42de4c3ceb9235fc91acffe746b29c29a8c366b7c60e4e67c466f36a4304c00fa9caf9d87976ba469bcbe06713b435f091ef2769fb160cdab33d3670680e
130
131keccak_512('The quick brown fox jumps over the lazy dog');
132// d135bb84d0439dbac432247ee573a23ea7d3c9deb2a968eb31d47c4fb45f1ef4422d6c531b5b9bd6f449ebcc449ea94d0a8f05f62130fda612da53c79659f609
133
134keccak_512('The quick brown fox jumps over the lazy dog.');
135// ab7192d2b11f51c7dd744e7b3441febf397ca07bf812cceae122ca4ded6387889064f8db9230f173f6d1ab6e24b6e50f065b039f799f5592360a6558eb52d760
136
137keccak_384('');
138// 2c23146a63a29acf99e73b88f8c24eaa7dc60aa771780ccc006afbfa8fe2479b2dd2b21362337441ac12b515911957ff
139
140keccak_384('The quick brown fox jumps over the lazy dog');
141// 283990fa9d5fb731d786c5bbee94ea4db4910f18c62c03d173fc0a5e494422e8a0b3da7574dae7fa0baf005e504063b3
142
143keccak_384('The quick brown fox jumps over the lazy dog.');
144// 9ad8e17325408eddb6edee6147f13856ad819bb7532668b605a24a2d958f88bd5c169e56dc4b2f89ffd325f6006d820b
145
146keccak_256('');
147// c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470
148
149keccak_256('The quick brown fox jumps over the lazy dog');
150// 4d741b6f1eb29cb2a9b9911c82f56fa8d73b04959d3d9d222895df6c0b28aa15
151
152keccak_256('The quick brown fox jumps over the lazy dog.');
153// 578951e24efd62a3d63a86f7cd19aaa53c898fe287d2552133220370240b572d
154
155keccak_224('');
156// f71837502ba8e10837bdd8d365adb85591895602fc552b48b7390abd
157
158keccak_224('The quick brown fox jumps over the lazy dog');
159// 310aee6b30c47350576ac2873fa89fd190cdc488442f3ef654cf23fe
160
161keccak_224('The quick brown fox jumps over the lazy dog.');
162// c59d4eaeac728671c635ff645014e2afa935bebffdb5fbd207ffdeab
163
164shake_128('', 256);
165// 7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26
166
167shake_256('', 512);
168// 46b9dd2b0ba88d13233b3feb743eeb243fcd52ea62b81b82b50c27646ed5762fd75dc4ddd8c0f200cb05019d67b592f6fc821c49479ab48640292eacb3b7c4be
169```
170It also supports UTF-8 encoding:
171
172Code
173```JavaScript
174sha3_512('中文');
175// 059bbe2efc50cc30e4d8ec5a96be697e2108fcbf9193e1296192eddabc13b143c0120d059399a13d0d42651efe23a6c1ce2d1efb576c5b207fa2516050505af7
176
177sha3_384('中文');
178// 9fb5b99e3c546f2738dcd50a14e9aef9c313800c1bf8cf76bc9b2c3a23307841364c5a2d0794702662c5796fb72f5432
179
180sha3_256('中文');
181// ac5305da3d18be1aed44aa7c70ea548da243a59a5fd546f489348fd5718fb1a0
182
183sha3_224('中文');
184// 106d169e10b61c2a2a05554d3e631ec94467f8316640f29545d163ee
185
186keccak_512('中文');
187// 2f6a1bd50562230229af34b0ccf46b8754b89d23ae2c5bf7840b4acfcef86f87395edc0a00b2bfef53bafebe3b79de2e3e01cbd8169ddbb08bde888dcc893524
188
189keccak_384('中文');
190// 743f64bb7544c6ed923be4741b738dde18b7cee384a3a09c4e01acaaac9f19222cdee137702bd3aa05dc198373d87d6c
191
192keccak_256('中文');
193// 70a2b6579047f0a977fcb5e9120a4e07067bea9abb6916fbc2d13ffb9a4e4eee
194
195keccak_224('中文');
196// f71837502ba8e10837bdd8d365adb85591895602fc552b48b7390abd
197```
198
199It also supports byte `Array`, `Uint8Array`, `ArrayBuffer` input:
200
201Code
202```JavaScript
203sha3_512([]);
204// a69f73cca23a9ac5c8b567dc185a756e97c982164fe25859e0d1dcc1475c80a615b2123af1f5f94c11e3e9402c3ac558f500199d95b6d3e301758586281dcd26
205
206sha3_512(new Uint8Array([]));
207// a69f73cca23a9ac5c8b567dc185a756e97c982164fe25859e0d1dcc1475c80a615b2123af1f5f94c11e3e9402c3ac558f500199d95b6d3e301758586281dcd26
208
209// ...
210```
211
212## Benchmark
213[UTF8](http://jsperf.com/sha3/5)
214[ASCII](http://jsperf.com/sha3/4)
215
216## License
217The project is released under the [MIT license](http://www.opensource.org/licenses/MIT).
218
219## Contact
220The project's website is located at https://github.com/emn178/js-sha3
221Author: Chen, Yi-Cyuan (emn178@gmail.com)