JavaScript implementation of popular cryptographic utilities with performance in mind. The lite version.
This is a fork of asmcrypto.js that includes only a minimal subset of ciphers required for OpenPGP.js. Please refer to the main repository for contributions and feature requests.
Add <script src="path/to/asmcrypto.js"></script>
into your page.
// Hash whole string at once
digest = asmCrypto.SHA256.hex("The quick brown fox jumps over the lazy dog");
- [Download] (#download)
- Build & Test
- Performance
- API Reference
- Bugs & TODO
- Donate
- Minified JS file 130KB,
- Source Map file 530KB,
- All-in-One archive 216KB.
Before you start check that npm is installed:
npm --version
Then download and build the stuff:
git clone https://github.com/openpgpjs/asmcrypto-lite.git
cd asmcrypto.js/
npm install
Running tests is always a good idea:
npm test
Congratulations! Now you have your asmcrypto.js
and asmcrypto.js.map
ready to use ☺
In the development of this project, special attention was paid to the performance issues. In the result of all the optimizations made this stuff is pretty fast under Firefox and Chrome.
My Intel® Core™ i7-3770 CPU @ 3.40GHz typical processing speeds are:
- Chrome/31.0
- SHA256: 51 MiB/s (9 times faster than SJCL and CryptoJS)
- AES-CBC: 47 MiB/s (13 times faster than CryptoJS and 20 times faster than SJCL)
- Firefox/26.0
- SHA256: 144 MiB/s (5 times faster than CryptoJS and 20 times faster than SJCL)
- AES-CBC: 81 MiB/s (3 times faster than CryptoJS and 8 times faster than SJCL)
See benchmarks:
Secure Hash Algorithm — a cryptographic hash function with 160-bit output.
A cryptographic hash fuction with 256-bit output.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns raw message digest as an Uint8Array
object.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns a string containing hex-encoded message digest.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns a string containing hex-encoded message digest.
Throws
TypeError
when something ridiculous is supplied as input data.
Secure Hash Algorithm — a cryptographic hash functions family.
A cryptographic hash fuction with 256-bit output.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns raw message digest as an Uint8Array
object.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns a string containing hex-encoded message digest.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns a string containing hex-encoded message digest.
Throws
TypeError
when something ridiculous is supplied as input data.
A cryptographic hash function with 512-bit output.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns raw message digest as an Uint8Array
object.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns a string containing hex-encoded message digest.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates message digest of the supplied input data
(can be a binary string or ArrayBuffer
/Uint8Array
object).
Returns a string containing hex-encoded message digest.
Throws
TypeError
when something ridiculous is supplied as input data.
Hash-based Message Authentication Code
Used to calculate message authentication code with a cryptographic hash function in combination with a secret cryptographic key.
Calculates HMAC-SHA1 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns araw message authentication code as an Uint8Array
object.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA1 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns a string containing hex-encoded message authentication code.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA1 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns a string containing base64-encoded message authentication code.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA256 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns araw message authentication code as an Uint8Array
object.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA256 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns a string containing hex-encoded message authentication code.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA256 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns a string containing base64-encoded message authentication code.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA512 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns araw message authentication code as an Uint8Array
object.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA512 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns a string containing hex-encoded message authentication code.
Throws
TypeError
when something ridiculous is supplied as input data.
Calculates HMAC-SHA512 of data
with password
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Returns a string containing base64-encoded message authentication code.
Throws
TypeError
when something ridiculous is supplied as input data.
Password-Based Key Derivation Function 2
Applies a cryptographic hash function to the input password or passphrase along with a salt value and repeats the process many times to produce a derived key, which can then be used as a cryptographic key in subsequent operations. The added computational work makes password cracking much more difficult.
Derive key from the password
with salt
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Optional iterations
(number of key derivatoin rounds) and dklen
(desired key length) may be supplied.
Throws
TypeError
.
The same as above except returning value type.
The same as above except returning value type.
Derive key from the password
with salt
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Optional iterations
(number of key derivatoin rounds) and dklen
(desired key length) may be supplied.
Throws
TypeError
.
The same as above except returning value type.
The same as above except returning value type.
Derive key from the password
with salt
. Both can be either binary strings or Uint8Array
/ArrayBuffer
objects.
Optional iterations
(number of key derivatoin rounds) and dklen
(desired key length) may be supplied.
Throws
TypeError
.
The same as above except returning value type.
The same as above except returning value type.
Advanced Encryption Standard
TODO
Cipher Block Chaining Mode.
Encrypts supplied data
with key
in CBC mode. Both can be either binary strings or Uint8Array
objects or ArrayBuffer
objects.
Optional padding
and iv
may be passed to override default settings (PKCS#7 padding is on and iv is zero-vector).
Returns encrypted data as Uint8Array
.
Decrypts supplied data
with key
in CBC mode. Both can be either binary strings or Uint8Array
objects or ArrayBuffer
objects.
Optional padding
and iv
may be passed to override default settings (PKCS#7 padding is on and iv is zero-vector).
Returns encrypted data as Uint8Array
.
Cipher Feedback Mode.
Encrypts supplied data
with key
in CFB mode. Both can be either binary strings or Uint8Array
objects or ArrayBuffer
objects.
Optional iv
may be passed to override default settings (zero-vector iv
).
Returns encrypted data as Uint8Array
.
Decrypts supplied data
with key
in CFB mode. Both can be either binary strings or Uint8Array
objects or ArrayBuffer
objects.
Optional iv
may be passed to override default settings (zero-vector iv
).
Returns encrypted data as Uint8Array
.
Output Feedback Mode.
Encrypts supplied data
with key
in OFB mode. Both can be either binary strings or Uint8Array
objects or ArrayBuffer
objects.
Optional iv
may be passed to override default settings (zero-vector iv
).
Returns encrypted data as Uint8Array
.
Decrypts supplied data
with key
in OFB mode. Both can be either binary strings or Uint8Array
objects or ArrayBuffer
objects.
Optional iv
may be passed to override default settings (zero-vector iv
).
Returns encrypted data as Uint8Array
.
TODO
Counter with CBC-MAC mode.
Due to JS limitations (counter is 32-bit unsigned) maximum encrypted message length is limited to near 64 GiB ( 2^36 - 16 ) per nonce
-key
pair.
Additional authenticated data adata
maximum length is limited to 65279 bytes ( 2^16 - 2^8 ),
wich is considered enough for the most of use-cases.
Optional tagSize
, the size of the authentication tag, may be 4, 6, 8, 12, 16 (default).
Keep in mind that same nonce must not be used more than once with the same key.
Encrypts supplied data
with key
-nonce
in CCM mode.
Returns encrypted data as Uint8Array
.
Decrypts supplied data
with key
-nonce
in CCM mode.
Returns encrypted data as Uint8Array
.
TODO
Generate RSA private key of bitlen
length along with the public exponent pubexp
.
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
TODO
ISAAC-based CSPRG
Drop-in replacement for window.crypto.getRandomValues
Perform PRNG seeding.
Allow implicitly-only seeded random output.
Disable implicit seeding warning when it's not desirable, e.g. at a unit test run.
- Progressive operations are temporary fade out, they'll be back with WebCrypto API;
- Moar docs needed ☺
Not yet implemented:
- scrypt,
- dsa, ecdsa,
- rsa-pkcs-v1.5
If you like this stuff feel free to donate some funds to 1CiGzP1EFLTftqkfvVtbwvZ9Koiuoc4FSC
☺