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