https://github.com/sabkat-ahmed-rafi/cryptonism
End-to-end encryption library for browser to secure authentication and sensitive data with zero-knowledge architecture.
https://github.com/sabkat-ahmed-rafi/cryptonism
aes-gcm-encryption argon2 argon2-browser browser-crypto end-to-end-encryption zero-knowledge
Last synced: 4 months ago
JSON representation
End-to-end encryption library for browser to secure authentication and sensitive data with zero-knowledge architecture.
- Host: GitHub
- URL: https://github.com/sabkat-ahmed-rafi/cryptonism
- Owner: sabkat-ahmed-rafi
- License: other
- Created: 2025-07-25T18:23:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-07-31T16:00:04.000Z (10 months ago)
- Last Synced: 2025-10-23T20:42:39.515Z (7 months ago)
- Topics: aes-gcm-encryption, argon2, argon2-browser, browser-crypto, end-to-end-encryption, zero-knowledge
- Language: TypeScript
- Homepage: https://cryptonism.vercel.app
- Size: 220 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 🔐 Cryptonism · [](https://github.com/sabkat-ahmed-rafi/cryptonism/blob/main/LICENSE)
**Frontend End-to-End Encryption Library**
Secure your authentication flows and sensitive data with zero-knowledge architecture directly in the browser.
---
## ✨ Features
- 🔑 Argon2id Key Derivation: Memory-hard password hashing resistant to attacks
- 🔐 AES-GCM Encryption: Authenticated encryption for maximum security
- 🛡️ Recovery System: Secure mnemonic-based key recovery
- 🔄 Password Rotation: Safe password updates without data loss
- 📊 Attempt Tracking: Built-in protection against brute force attacks
- ⚡ TypeScript Support: Full type safety and IntelliSense support
---
## 📚 Documentation
Full documentation is available here: [View the Docs](https://cryptonism.vercel.app)
## 📦 Installation
```bash
npm install cryptonism
```
## Usage Example
### Encrypt An Account
```typescript
import { generateEncryptedKey } from 'cryptonism';
const result = await generateEncryptedKey({
password: 'user-master-password'
});
if (result.success) {
// Store these in your database
const data = {
encryptedKey: result.encryptedKey,
salt: result.salt,
iv: result.iv,
encryptedRecoveryKey: result.encryptedRecoveryKey,
recoverySalt: result.recoverySalt,
recoveryIV: result.recoveryIV
};
// CRITICAL: Show recovery phrase to user ONCE
alert(`Save this recovery phrase: ${result.recoveryPhrase}`);
} else {
console.error('Key generation failed:', result.error.message);
}
```
### With Custom Argon2 Configuration
```typescript
// Note: use same custom argonConfig for all functions
const result = await generateEncryptedKey({
password: 'user-master-password',
argonConfig: {
time: 3, // More iterations for higher security
mem: 32000, // 32MB memory usage
hashLen: 32 // 32-byte output
}
});
// The Default Argon2 Config
const defaultArgonConfig = {
time: 3,
mem: 65536,
hashLen: 32
};
```
### Decrypt An Account
```typescript
import { decryptGeneratedKey } from 'cryptonism';
// Data from your database
const data = {
salt: 'base64-salt-string',
iv: 'base64-iv-string',
encryptedKey: 'base64-encrypted-key'
};
const result = await decryptGeneratedKey({
salt: data.salt,
iv: data.iv,
encryptedKey: data.encryptedKey,
password: 'user-entered-password'
});
if (result.success) {
const { decryptedKey } = result;
// Now you can use this key to encrypt/decrypt secrets
console.log('Vault unlocked successfully!');
} else {
console.error('Failed to unlock vault:', result.error.message);
}
```
### Decrypt With Attempt Tracking
```typescript
const result = await decryptGeneratedKey({
salt: data.salt,
iv: data.iv,
encryptedKey: data.encryptedKey,
password: userPassword,
trackAttempts: {
enable: true,
id: `user-${userId}`, // Unique identifier for this user
maxAttempts: 5 // Lock after 5 failed attempts
}
});
if (result.success) {
console.log('Login successful!');
} else {
console.error(`Login failed. Attempts: ${result.attempts}/5`);
if (result.attempts >= 5) {
console.error('Account locked due to too many failed attempts');
}
}
```
### Encrypt Each Secret Data
```typescript
import { encryptSecret } from 'cryptonism';
// Assuming you have a decrypted key from decryptGeneratedKey
const result = await encryptSecret({
secret: 'my-api-key-abc123',
decryptedKey: userDecryptedKey
});
if (result.success) {
// Store these values in your database
const secretRecord = {
encryptedSecret: result.encryptedSecret,
iv: result.iv,
};
await saveSecretToDatabase(secretRecord);
console.log('Secret encrypted and saved!');
} else {
console.error('Encryption failed:', result.error.message);
}
```
### Decrypt Each Secret
```typescript
import { decryptSecret } from 'cryptonism';
// Data retrieved from your database
const secretRecord = {
encryptedSecret: 'base64-encrypted-data',
iv: 'base64-iv-string'
};
const result = await decryptSecret({
encryptedSecret: secretRecord.encryptedSecret,
iv: secretRecord.iv,
decryptedKey: userDecryptedKey // From decryptGeneratedKey
});
if (result.success) {
console.log('Secret:', result.decryptedSecret);
// Use the decrypted secret (API key, password, etc.)
} else {
console.error('Decryption failed:', result.error.message);
}
```
For advanced usage, configuration options, and troubleshooting tips, please refer to the [Full Documentation](https://cryptonism.vercel.app).