asmcrypto-lite

asmCrypto Lite

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.

Synopsis

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");

Index

• [Download] (#download)
• Build & Test
• Performance
• API Reference
  • Message Digest
    • SHA1
    • SHA256
    • SHA512
  • Hash-based Message Authentication
    • HMAC-SHA1
    • HMAC-SHA256
    • HMAC-SHA512
  • Password-based Key Derivation
    • PBKDF2-HMAC-SHA1
    • PBKDF2-HMAC-SHA256
    • PBKDF2-HMAC-SHA512
  • Block Cipher
    • AES-EBC
    • AES-CBC
    • AES-CFB
    • AES-OFB
    • AES-CTR
    • AES-CCM
    • AES-GCM
  • Asymmetric encryption
    • RSA
    • RSA-OAEP-SHA1
    • RSA-OAEP-SHA256
    • RSA-OAEP-SHA512
    • RSA-PSS-SHA1
    • RSA-PSS-SHA256
    • RSA-PSS-SHA512
  • Cryptographically secure pseudorandom number generator
• Bugs & TODO
• Donate

Download

• Minified JS file 130KB,
• Source Map file 530KB,
• All-in-One archive 216KB.

Build & Test

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 ☺

Performance

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:

• SHA256,
• HMAC-SHA256,
• PBKDF2-HMAC-SHA256,
• AES,
• Modular exponentiation (used internally in RSA).

API Reference

Message Digest

SHA1

Secure Hash Algorithm — a cryptographic hash function with 160-bit output.

A cryptographic hash fuction with 256-bit output.

SHA1.BLOCK_SIZE = 64

SHA1.HASH_SIZE = 20

SHA1.bytes( data )

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.

SHA1.hex( 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.

SHA1.base64( 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.

SHA256

Secure Hash Algorithm — a cryptographic hash functions family.

A cryptographic hash fuction with 256-bit output.

SHA256.BLOCK_SIZE = 64

SHA256.HASH_SIZE = 32

SHA256.bytes( data )

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.

SHA256.hex( 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.

SHA256.base64( 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.

SHA512

A cryptographic hash function with 512-bit output.

SHA512.BLOCK_SIZE = 128

SHA512.HASH_SIZE = 64

SHA512.bytes( data )

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.

SHA512.hex( 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.

SHA512.base64( 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.

HMAC

Hash-based Message Authentication Code

Used to calculate message authentication code with a cryptographic hash function in combination with a secret cryptographic key.

HMAC_SHA1

HMAC_SHA1.BLOCK_SIZE = 64

HMAC_SHA1.HMAC_SIZE = 20

HMAC_SHA1.bytes( data, password )

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.

HMAC_SHA1.hex( data, password )

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.

HMAC_SHA1.base64( data, password )

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.

HMAC_SHA256

HMAC_SHA256.BLOCK_SIZE = 64

HMAC_SHA256.HMAC_SIZE = 32

HMAC_SHA256.bytes( data, password )

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.

HMAC_SHA256.hex( data, password )

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.

HMAC_SHA256.base64( data, password )

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.

HMAC_SHA512

HMAC_SHA512.BLOCK_SIZE = 128

HMAC_SHA512.HMAC_SIZE = 64

HMAC_SHA512.bytes( data, password )

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.

HMAC_SHA512.hex( data, password )

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.

HMAC_SHA512.base64( data, password )

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.

PBKDF2

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.

PBKDF2_HMAC_SHA1

PBKDF2_HMAC_SHA1.bytes( password, salt, iterations, dklen )

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.

PBKDF2_HMAC_SHA1.hex( password, salt, iterations, dklen )

The same as above except returning value type.

PBKDF2_HMAC_SHA1.base64( password, salt, iterations, dklen )

The same as above except returning value type.

PBKDF2_HMAC_SHA256

PBKDF2_HMAC_SHA256.bytes( password, salt, iterations, dklen )

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.

PBKDF2_HMAC_SHA256.hex( password, salt, iterations, dklen )

The same as above except returning value type.

PBKDF2_HMAC_SHA256.base64( password, salt, iterations, dklen )

The same as above except returning value type.

PBKDF2_HMAC_SHA512

PBKDF2_HMAC_SHA512.bytes( password, salt, iterations, dklen )

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.

PBKDF2_HMAC_SHA512.hex( password, salt, iterations, dklen )

The same as above except returning value type.

PBKDF2_HMAC_SHA512.base64( password, salt, iterations, dklen )

The same as above except returning value type.

AES

Advanced Encryption Standard

AES_ECB

TODO

AES_CBC

Cipher Block Chaining Mode.

AES_CBC.encrypt( data, key, padding, iv )

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.

AES_CBC.decrypt( data, key, padding, iv )

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.

AES_CFB

Cipher Feedback Mode.

AES_CFB.encrypt( data, key, iv )

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.

AES_CFB.decrypt( data, key, iv )

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.

AES_OFB

Output Feedback Mode.

AES_OFB.encrypt( data, key, iv )

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.

AES_OFB.decrypt( data, key, iv )

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.

AES_CTR

TODO

AES_CCM

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.

AES_CCM.encrypt( data, key, nonce, adata, tagsize )

Encrypts supplied data with key-nonce in CCM mode.

Returns encrypted data as Uint8Array.

AES_CCM.decrypt( data, key, nonce, adata, tagsize )

Decrypts supplied data with key-nonce in CCM mode.

Returns encrypted data as Uint8Array.

AES_GCM

TODO

RSA

RSA.generateKey( bitlen, pubexp )

Generate RSA private key of bitlen length along with the public exponent pubexp.

RSA_OAEP_SHA1

RSA_OAEP_SHA1.encrypt( data, key, label )

TODO

RSA_OAEP_SHA1.decrypt( data, key, label )

TODO

RSA_OAEP_SHA256

RSA_OAEP_SHA256.encrypt( data, key, label )

TODO

RSA_OAEP_SHA256.decrypt( data, key, label )

TODO

RSA_OAEP_SHA512

RSA_OAEP_SHA512.encrypt( data, key, label )

TODO

RSA_OAEP_SHA512.decrypt( data, key, label )

TODO

RSA_PSS_SHA1

RSA_PSS_SHA1.sign( data, key, slen )

TODO

RSA_PSS_SHA1.verify( signature, data, key, slen )

TODO

RSA_PSS_SHA256

RSA_PSS_SHA256.sign( data, key, slen )

TODO

RSA_PSS_SHA256.verify( signature, data, key, slen )

TODO

RSA_PSS_SHA512

RSA_PSS_SHA512.sign( data, key, slen )

TODO

RSA_PSS_SHA512.verify( signature, data, key, slen )

TODO

Cryptographically secure pseudorandom number generator

ISAAC-based CSPRG

random.getValues( buffer )

Drop-in replacement for window.crypto.getRandomValues

random.getValues.seed( seed )

Perform PRNG seeding.

random.getValues.allowWeak = false

Allow implicitly-only seeded random output.

random.getValues.skipSystemRNGWarning = false

Disable implicit seeding warning when it's not desirable, e.g. at a unit test run.

Bugs & TODO

• 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

Donate

If you like this stuff feel free to donate some funds to 1CiGzP1EFLTftqkfvVtbwvZ9Koiuoc4FSC ☺