![](\"https://raw.githubusercontent.com/entronad/crypto-es/next/devdoc/logo.png\"){kind=logo}
\n\n\n
\n\n[](https://www.npmjs.com/package/crypto-es) [](https://opensource.org/licenses/MIT) [](https://www.typescriptlang.org/)\n\nA modern JavaScript/TypeScript cryptography library offering a comprehensive collection of hash functions, ciphers, encoders, and key derivation functions. Pure TypeScript implementation with full ES6 module support and CommonJS compatibility.\n\n## β¨ Features\n\n- π **Modern Implementation** - Pure TypeScript with full type definitions\n- π¦ **Dual Module Support** - ESM and CommonJS outputs for maximum compatibility\n- π³ **Tree-Shakeable** - Import only what you need for optimal bundle size\n- π **Streaming API** - Process large data efficiently with progressive hashing/encryption\n- π **Comprehensive Algorithms** - Hash functions, symmetric ciphers, KDFs, and more\n- πͺ **Zero Dependencies** - No external dependencies for lightweight integration\n- β‘ **High Performance** - Optimized implementations with streaming support\n- π‘οΈ **Battle-Tested** - Extensive test suite with known test vectors\n\n## π¦ Installation\n\n```bash\n# Using npm\nnpm install crypto-es\n\n# Using yarn\nyarn add crypto-es\n\n# Using pnpm\npnpm add crypto-es\n```\n\n## π Quick Start\n\n### Basic Hashing\n\n```typescript\nimport { MD5, SHA256, SHA512 } from 'crypto-es';\n\n// Simple hashing\nconst hash1 = MD5('Hello World').toString();\n// d41d8cd98f00b204e9800998ecf8427e\n\nconst hash2 = SHA256('Hello World').toString();\n// a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b3f8b4c5cdcdcd9d0\n\nconst hash3 = SHA512('Hello World').toString();\n// 2c74fd17edafd80e8447b0d46741ee243b7eb74dd2149a0ab1b9246fb30382f27e853d8585719e0e67cbda0daa8f51671064615d645ae27acb15bfb1447f459b\n```\n\n### Basic Encryption\n\n```typescript\nimport { AES, DES, TripleDES } from 'crypto-es';\n\n// AES encryption\nconst encrypted = AES.encrypt('Secret Message', 'secret key').toString();\nconst decrypted = AES.decrypt(encrypted, 'secret key').toString();\n\n// DES encryption\nconst desEncrypted = DES.encrypt('Secret Message', 'secret key').toString();\nconst desDecrypted = DES.decrypt(desEncrypted, 'secret key').toString();\n```\n\n### Encoding/Decoding\n\n```typescript\nimport { Base64, Hex, UTF8 } from 'crypto-es';\n\n// Base64 encoding\nconst base64 = Base64.stringify(UTF8.parse('Hello World'));\n// SGVsbG8gV29ybGQ=\n\n// Hex encoding\nconst hex = Hex.stringify(UTF8.parse('Hello World'));\n// 48656c6c6f20576f726c64\n```\n\n## π Complete Algorithm Reference\n\n### Hash Functions\n\n| Algorithm | Description | Output Size | Usage |\n|-----------|-------------|-------------|--------|\n| [MD5](#md5) | Legacy hash function | 128 bits | Legacy compatibility only |\n| [SHA1](#sha1) | SHA-1 hash function | 160 bits | Legacy systems |\n| [SHA224](#sha224) | SHA-2 family | 224 bits | Moderate security |\n| [SHA256](#sha256) | SHA-2 family | 256 bits | **Recommended** |\n| [SHA384](#sha384) | SHA-2 family | 384 bits | High security |\n| [SHA512](#sha512) | SHA-2 family | 512 bits | Maximum security |\n| [SHA3](#sha3) | Latest SHA-3 standard | 224-512 bits | Modern applications |\n| [RIPEMD160](#ripemd160) | RIPEMD family | 160 bits | Specialized use |\n\n### Symmetric Ciphers\n\n| Algorithm | Key Size | Block Size | Description |\n|-----------|----------|------------|-------------|\n| [AES](#aes) | 128/192/256 bits | 128 bits | **Industry standard** |\n| [DES](#des) | 56 bits | 64 bits | Legacy only |\n| [TripleDES](#tripledes) | 168 bits | 64 bits | Legacy upgrade from DES |\n| [Rabbit](#rabbit) | 128 bits | Stream | High-performance stream cipher |\n| [RC4](#rc4) | Variable | Stream | Legacy stream cipher |\n| [Blowfish](#blowfish) | 32-448 bits | 64 bits | Variable key length |\n\n### Key Derivation Functions\n\n| Algorithm | Description | Usage |\n|-----------|-------------|--------|\n| [PBKDF2](#pbkdf2) | Password-Based KDF v2 | **Recommended for passwords** |\n| [EvpKDF](#evpkdf) | OpenSSL EVP KDF | OpenSSL compatibility |\n\n### Encoders\n\n| Encoder | Description |\n|---------|-------------|\n| [Base64](#base64) | Standard Base64 encoding |\n| [Base64url](#base64url) | URL-safe Base64 encoding |\n| [Hex](#hex) | Hexadecimal encoding |\n| [UTF8](#utf8) | UTF-8 text encoding |\n| [UTF16](#utf16) | UTF-16 text encoding |\n| [Latin1](#latin1) | Latin-1 text encoding |\n\n### Cipher Modes\n\n| Mode | Description | IV Required |\n|------|-------------|-------------|\n| [CBC](#cbc) | Cipher Block Chaining (default) | Yes |\n| [ECB](#ecb) | Electronic Codebook | No |\n| [CFB](#cfb) | Cipher Feedback | Yes |\n| [OFB](#ofb) | Output Feedback | Yes |\n| [CTR](#ctr) | Counter | Yes |\n\n### Padding Schemes\n\n| Padding | Description |\n|---------|-------------|\n| [PKCS7](#pkcs7) | PKCS#7 padding (default) |\n| [AnsiX923](#ansix923) | ANSI X9.23 padding |\n| [ISO10126](#iso10126) | ISO 10126 padding |\n| [ISO97971](#iso97971) | ISO/IEC 9797-1 padding |\n| [ZeroPadding](#zeropadding) | Zero byte padding |\n| [NoPadding](#nopadding) | No padding |\n\n## π Detailed Usage Guide\n\n### Hash Algorithms\n\n#### MD5\n\n```typescript\nimport { MD5, HmacMD5 } from 'crypto-es';\n\n// Basic hashing\nconst hash = MD5('message').toString();\n\n// HMAC-MD5\nconst hmac = HmacMD5('message', 'secret key').toString();\n\n// Progressive hashing\nconst hasher = MD5Algo.create();\nhasher.update('message part 1');\nhasher.update('message part 2');\nconst progressiveHash = hasher.finalize().toString();\n```\n\n#### SHA1\n\n```typescript\nimport { SHA1, HmacSHA1, SHA1Algo } from 'crypto-es';\n\n// Basic hashing\nconst hash = SHA1('message').toString();\n\n// HMAC-SHA1\nconst hmac = HmacSHA1('message', 'secret key').toString();\n\n// Progressive hashing\nconst hasher = SHA1Algo.create();\nhasher.update('large data chunk 1');\nhasher.update('large data chunk 2');\nconst result = hasher.finalize().toString();\n```\n\n#### SHA224\n\n```typescript\nimport { SHA224, HmacSHA224 } from 'crypto-es';\n\n// Basic hashing\nconst hash = SHA224('message').toString();\n\n// HMAC-SHA224\nconst hmac = HmacSHA224('message', 'secret key').toString();\n```\n\n#### SHA256\n\n```typescript\nimport { SHA256, HmacSHA256, SHA256Algo } from 'crypto-es';\n\n// Basic hashing\nconst hash = SHA256('message').toString();\n\n// HMAC-SHA256 (commonly used for API authentication)\nconst hmac = HmacSHA256('message', 'secret key').toString();\n\n// Progressive hashing for large files\nconst hasher = SHA256Algo.create();\nhasher.update('chunk1');\nhasher.update('chunk2');\nhasher.update('chunk3');\nconst fileHash = hasher.finalize().toString();\n\n// Different output formats\nimport { Hex, Base64 } from 'crypto-es';\nconst hashHex = SHA256('message').toString(Hex);\nconst hashBase64 = SHA256('message').toString(Base64);\n```\n\n#### SHA384\n\n```typescript\nimport { SHA384, HmacSHA384 } from 'crypto-es';\n\n// Basic hashing\nconst hash = SHA384('message').toString();\n\n// HMAC-SHA384\nconst hmac = HmacSHA384('message', 'secret key').toString();\n```\n\n#### SHA512\n\n```typescript\nimport { SHA512, HmacSHA512, SHA512Algo } from 'crypto-es';\n\n// Basic hashing\nconst hash = SHA512('message').toString();\n\n// HMAC-SHA512\nconst hmac = HmacSHA512('message', 'secret key').toString();\n\n// Progressive hashing with typed arrays\nimport { WordArray } from 'crypto-es';\nconst hasher = SHA512Algo.create();\nconst data1 = WordArray.create(new Uint8Array([1, 2, 3, 4]));\nconst data2 = WordArray.create(new Uint8Array([5, 6, 7, 8]));\nhasher.update(data1);\nhasher.update(data2);\nconst result = hasher.finalize();\n```\n\n#### SHA3\n\n```typescript\nimport { SHA3 } from 'crypto-es';\n\n// SHA3-256 (default)\nconst hash256 = SHA3('message').toString();\n\n// SHA3-224\nconst hash224 = SHA3('message', { outputLength: 224 }).toString();\n\n// SHA3-384\nconst hash384 = SHA3('message', { outputLength: 384 }).toString();\n\n// SHA3-512\nconst hash512 = SHA3('message', { outputLength: 512 }).toString();\n```\n\n#### RIPEMD160\n\n```typescript\nimport { RIPEMD160, HmacRIPEMD160 } from 'crypto-es';\n\n// Basic hashing\nconst hash = RIPEMD160('message').toString();\n\n// HMAC-RIPEMD160\nconst hmac = HmacRIPEMD160('message', 'secret key').toString();\n```\n\n### Symmetric Encryption\n\n#### AES\n\n```typescript\nimport { AES, ECB, CBC, CFB, OFB, CTR, NoPadding, PKCS7 } from 'crypto-es';\n\n// Simple encryption with password\nconst encrypted = AES.encrypt('Secret Message', 'password').toString();\nconst decrypted = AES.decrypt(encrypted, 'password').toString(UTF8);\n\n// AES with specific key size (128/192/256 bits)\nimport { PBKDF2, WordArray } from 'crypto-es';\nconst key128 = PBKDF2('password', 'salt', { keySize: 128/32 });\nconst key192 = PBKDF2('password', 'salt', { keySize: 192/32 });\nconst key256 = PBKDF2('password', 'salt', { keySize: 256/32 });\n\n// Encryption with different modes\nconst encrypted1 = AES.encrypt('message', key256, { mode: ECB }).toString();\nconst encrypted2 = AES.encrypt('message', key256, { mode: CBC }).toString();\nconst encrypted3 = AES.encrypt('message', key256, { mode: CFB }).toString();\nconst encrypted4 = AES.encrypt('message', key256, { mode: OFB }).toString();\nconst encrypted5 = AES.encrypt('message', key256, { mode: CTR }).toString();\n\n// Custom IV (Initialization Vector)\nconst iv = WordArray.random(128/8);\nconst encrypted = AES.encrypt('message', key256, { iv: iv }).toString();\n\n// Different padding schemes\nconst encrypted6 = AES.encrypt('message', key256, { padding: PKCS7 }).toString();\nconst encrypted7 = AES.encrypt('message', key256, { padding: NoPadding }).toString();\n\n// Streaming encryption for large data\nimport { AESAlgo } from 'crypto-es';\nconst key = PBKDF2('password', 'salt', { keySize: 256/32 });\nconst iv = WordArray.random(128/8);\nconst aes = AESAlgo.createEncryptor(key, { iv: iv });\n\nconst part1 = aes.process('part 1 of data');\nconst part2 = aes.process('part 2 of data');\nconst part3 = aes.process('part 3 of data');\nconst encrypted = part1.concat(part2).concat(part3).concat(aes.finalize());\n```\n\n#### DES\n\n```typescript\nimport { DES, DESAlgo } from 'crypto-es';\n\n// Simple DES encryption\nconst encrypted = DES.encrypt('Message', 'password').toString();\nconst decrypted = DES.decrypt(encrypted, 'password').toString(UTF8);\n\n// DES with custom options\nimport { ECB, NoPadding } from 'crypto-es';\nconst encrypted = DES.encrypt('Message', 'password', {\n mode: ECB,\n padding: NoPadding\n}).toString();\n\n// Streaming DES\nconst des = DESAlgo.createEncryptor('password');\nconst encrypted = des.finalize('Message').toString();\n```\n\n#### TripleDES\n\n```typescript\nimport { TripleDES, TripleDESAlgo } from 'crypto-es';\n\n// Simple 3DES encryption\nconst encrypted = TripleDES.encrypt('Message', 'password').toString();\nconst decrypted = TripleDES.decrypt(encrypted, 'password').toString(UTF8);\n\n// 3DES with 192-bit key\nimport { PBKDF2 } from 'crypto-es';\nconst key = PBKDF2('password', 'salt', { keySize: 192/32 });\nconst encrypted = TripleDES.encrypt('Message', key).toString();\n\n// Streaming 3DES\nconst cipher = TripleDESAlgo.createEncryptor(key);\nconst encrypted = cipher.finalize('Message').toString();\n```\n\n#### Rabbit\n\n```typescript\nimport { Rabbit, RabbitAlgo } from 'crypto-es';\n\n// Simple Rabbit encryption\nconst encrypted = Rabbit.encrypt('Message', 'password').toString();\nconst decrypted = Rabbit.decrypt(encrypted, 'password').toString(UTF8);\n\n// Rabbit with IV\nimport { WordArray } from 'crypto-es';\nconst key = WordArray.random(128/8);\nconst iv = WordArray.random(64/8);\nconst encrypted = Rabbit.encrypt('Message', key, { iv: iv }).toString();\n\n// Streaming Rabbit\nconst cipher = RabbitAlgo.createEncryptor(key, { iv: iv });\nconst encrypted = cipher.finalize('Message').toString();\n```\n\n#### RC4\n\n```typescript\nimport { RC4, RC4Drop } from 'crypto-es';\n\n// Simple RC4 encryption\nconst encrypted = RC4.encrypt('Message', 'password').toString();\nconst decrypted = RC4.decrypt(encrypted, 'password').toString(UTF8);\n\n// RC4Drop (more secure variant)\nconst encrypted = RC4Drop.encrypt('Message', 'password').toString();\nconst decrypted = RC4Drop.decrypt(encrypted, 'password').toString(UTF8);\n\n// RC4 with custom drop value\nimport { RC4DropAlgo } from 'crypto-es';\nconst cipher = RC4DropAlgo.createEncryptor('password', { drop: 3072/4 });\nconst encrypted = cipher.finalize('Message').toString();\n```\n\n#### Blowfish\n\n```typescript\nimport { Blowfish, BlowfishAlgo } from 'crypto-es';\n\n// Simple Blowfish encryption\nconst encrypted = Blowfish.encrypt('Message', 'password').toString();\nconst decrypted = Blowfish.decrypt(encrypted, 'password').toString(UTF8);\n\n// Blowfish with variable key length (32-448 bits)\nimport { PBKDF2 } from 'crypto-es';\nconst key128 = PBKDF2('password', 'salt', { keySize: 128/32 });\nconst key256 = PBKDF2('password', 'salt', { keySize: 256/32 });\nconst key448 = PBKDF2('password', 'salt', { keySize: 448/32 });\n\nconst encrypted1 = Blowfish.encrypt('Message', key128).toString();\nconst encrypted2 = Blowfish.encrypt('Message', key256).toString();\nconst encrypted3 = Blowfish.encrypt('Message', key448).toString();\n```\n\n### Key Derivation Functions\n\n#### PBKDF2\n\n```typescript\nimport { PBKDF2, SHA256Algo, SHA512Algo } from 'crypto-es';\n\n// Basic PBKDF2 with default settings (SHA1, 1 iteration)\nconst key = PBKDF2('password', 'salt');\n\n// PBKDF2 with custom settings\nconst key256 = PBKDF2('password', 'salt', {\n keySize: 256/32, // 256-bit key\n iterations: 10000, // 10,000 iterations\n hasher: SHA256Algo // SHA256 hasher\n});\n\nconst key512 = PBKDF2('password', 'salt', {\n keySize: 512/32, // 512-bit key\n iterations: 100000, // 100,000 iterations\n hasher: SHA512Algo // SHA512 hasher\n});\n\n// Use for AES encryption\nimport { AES } from 'crypto-es';\nconst derivedKey = PBKDF2('mypassword', 'mysalt', {\n keySize: 256/32,\n iterations: 10000\n});\nconst encrypted = AES.encrypt('Secret', derivedKey).toString();\n```\n\n#### EvpKDF\n\n```typescript\nimport { EvpKDF, MD5Algo, SHA256Algo } from 'crypto-es';\n\n// Basic EvpKDF\nconst key = EvpKDF('password', 'salt');\n\n// EvpKDF with custom settings\nconst key256 = EvpKDF('password', 'salt', {\n keySize: 256/32,\n iterations: 1000,\n hasher: SHA256Algo\n});\n\n// Compatible with OpenSSL EVP_BytesToKey\nconst opensslKey = EvpKDF('password', 'salt', {\n keySize: 256/32,\n ivSize: 128/32,\n hasher: MD5Algo\n});\n```\n\n### Encoders\n\n#### Base64\n\n```typescript\nimport { Base64, UTF8, WordArray } from 'crypto-es';\n\n// Encode string to Base64\nconst encoded = Base64.stringify(UTF8.parse('Hello World'));\n// SGVsbG8gV29ybGQ=\n\n// Decode Base64 to string\nconst decoded = UTF8.stringify(Base64.parse('SGVsbG8gV29ybGQ='));\n// Hello World\n\n// Base64 with WordArray\nconst wordArray = WordArray.create([0x48656c6c, 0x6f20576f, 0x726c6400], 11);\nconst base64 = Base64.stringify(wordArray);\n```\n\n#### Base64url\n\n```typescript\nimport { Base64url, UTF8 } from 'crypto-es';\n\n// URL-safe Base64 encoding (no padding, - and _ instead of + and /)\nconst encoded = Base64url.stringify(UTF8.parse('Hello World??'));\n// SGVsbG8gV29ybGQ_Pw\n\n// Decode Base64url\nconst decoded = UTF8.stringify(Base64url.parse('SGVsbG8gV29ybGQ_Pw'));\n// Hello World??\n```\n\n#### Hex\n\n```typescript\nimport { Hex, UTF8, WordArray } from 'crypto-es';\n\n// Encode string to Hex\nconst encoded = Hex.stringify(UTF8.parse('Hello World'));\n// 48656c6c6f20576f726c64\n\n// Decode Hex to string\nconst decoded = UTF8.stringify(Hex.parse('48656c6c6f20576f726c64'));\n// Hello World\n\n// Hex with WordArray\nconst wordArray = WordArray.create([0x48656c6c, 0x6f20576f, 0x726c6400], 11);\nconst hex = Hex.stringify(wordArray);\n// 48656c6c6f20576f726c64\n```\n\n#### UTF8\n\n```typescript\nimport { UTF8, WordArray } from 'crypto-es';\n\n// Parse UTF8 string to WordArray\nconst wordArray = UTF8.parse('Hello World δ½ ε₯½δΈη');\n\n// Stringify WordArray to UTF8\nconst utf8String = UTF8.stringify(wordArray);\n\n// Handle special characters\nconst emoji = UTF8.parse('πππ');\nconst back = UTF8.stringify(emoji);\n```\n\n#### UTF16\n\n```typescript\nimport { UTF16, UTF16BE, UTF16LE } from 'crypto-es';\n\n// UTF16 Big Endian\nconst encodedBE = UTF16BE.stringify(UTF16BE.parse('Hello'));\n\n// UTF16 Little Endian\nconst encodedLE = UTF16LE.stringify(UTF16LE.parse('Hello'));\n\n// Auto-detect endianness\nconst encoded = UTF16.stringify(UTF16.parse('Hello'));\n```\n\n#### Latin1\n\n```typescript\nimport { Latin1 } from 'crypto-es';\n\n// Parse Latin1 string to WordArray\nconst wordArray = Latin1.parse('Hello World');\n\n// Stringify WordArray to Latin1\nconst latin1String = Latin1.stringify(wordArray);\n```\n\n### Cipher Modes\n\n#### CBC\n\n```typescript\nimport { AES, CBC, PKCS7 } from 'crypto-es';\n\n// CBC mode (default)\nconst encrypted = AES.encrypt('message', 'password', {\n mode: CBC,\n padding: PKCS7\n}).toString();\n```\n\n#### ECB\n\n```typescript\nimport { AES, ECB } from 'crypto-es';\n\n// ECB mode (not recommended for security)\nconst encrypted = AES.encrypt('message', 'password', {\n mode: ECB\n}).toString();\n```\n\n#### CFB\n\n```typescript\nimport { AES, CFB } from 'crypto-es';\n\n// CFB mode\nconst encrypted = AES.encrypt('message', 'password', {\n mode: CFB\n}).toString();\n```\n\n#### OFB\n\n```typescript\nimport { AES, OFB } from 'crypto-es';\n\n// OFB mode\nconst encrypted = AES.encrypt('message', 'password', {\n mode: OFB\n}).toString();\n```\n\n#### CTR\n\n```typescript\nimport { AES, CTR } from 'crypto-es';\n\n// CTR mode\nconst encrypted = AES.encrypt('message', 'password', {\n mode: CTR\n}).toString();\n```\n\n### Padding Schemes\n\n#### PKCS7\n\n```typescript\nimport { AES, PKCS7 } from 'crypto-es';\n\n// PKCS7 padding (default)\nconst encrypted = AES.encrypt('message', 'password', {\n padding: PKCS7\n}).toString();\n```\n\n#### AnsiX923\n\n```typescript\nimport { AES, AnsiX923 } from 'crypto-es';\n\n// ANSI X9.23 padding\nconst encrypted = AES.encrypt('message', 'password', {\n padding: AnsiX923\n}).toString();\n```\n\n#### ISO10126\n\n```typescript\nimport { AES, ISO10126 } from 'crypto-es';\n\n// ISO 10126 padding\nconst encrypted = AES.encrypt('message', 'password', {\n padding: ISO10126\n}).toString();\n```\n\n#### ISO97971\n\n```typescript\nimport { AES, ISO97971 } from 'crypto-es';\n\n// ISO/IEC 9797-1 padding\nconst encrypted = AES.encrypt('message', 'password', {\n padding: ISO97971\n}).toString();\n```\n\n#### ZeroPadding\n\n```typescript\nimport { AES, ZeroPadding } from 'crypto-es';\n\n// Zero padding\nconst encrypted = AES.encrypt('message', 'password', {\n padding: ZeroPadding\n}).toString();\n```\n\n#### NoPadding\n\n```typescript\nimport { AES, NoPadding, WordArray } from 'crypto-es';\n\n// No padding (message must be multiple of block size)\nconst message = WordArray.create([0x00112233, 0x44556677, 0x8899aabb, 0xccddeeff]);\nconst encrypted = AES.encrypt(message, 'password', {\n padding: NoPadding\n}).toString();\n```\n\n## π§ Advanced Topics\n\n### Working with WordArray\n\n```typescript\nimport { WordArray, UTF8, Hex, Base64 } from 'crypto-es';\n\n// Create WordArray from different sources\nconst wa1 = WordArray.create([0x12345678, 0x9abcdef0]);\nconst wa2 = WordArray.random(16); // 16 random bytes\nconst wa3 = UTF8.parse('Hello World');\nconst wa4 = Hex.parse('48656c6c6f');\nconst wa5 = Base64.parse('SGVsbG8=');\n\n// Concatenate WordArrays\nconst combined = wa1.concat(wa2).concat(wa3);\n\n// Clone WordArray\nconst cloned = wa1.clone();\n\n// Get bytes\nconst bytes = wa1.sigBytes;\n\n// Convert to different formats\nconst hex = wa1.toString(Hex);\nconst base64 = wa1.toString(Base64);\nconst utf8 = wa1.toString(UTF8);\n```\n\n### Streaming Large Files\n\n```typescript\nimport { SHA256Algo, AESAlgo, WordArray } from 'crypto-es';\n\n// Hash large file in chunks\nasync function hashLargeFile(file: File): Promise