A fast, native, environment-agnostic, cryptographic engine for the web
importEnigmafrom'@cubbit/enigma';newEnigma.AES().init().then(async(aes: Enigma.AES)=>{constmy_secret='My secret';constcipher=awaitaes.encrypt(my_secret);console.log(cipher);});/*{ content: <Buffer 16 6e b6 61 1b e0 d9 3a 25>, tag: <Buffer 07 cf 9d 9c 53 6a 13 5f 5f 24 75 a3 64 1f bd 89>, iv: <Buffer 62 d6 9b 8c bc 23 3c e5 9b 77 30 2e 56 cc f9 35>}*/Enigma is a crypto library available both for Node.js platform and for the Web. It relies on OpenSSL to provide the most common cryptographical utilities. In a web environment, Enigma leverages on a WebAssembly-compiled version of OpenSSL to boost performances.
Enigma is a npm module available through the npm registry.
Installation is done both in Node.js and in a web environment using the npm install command:
npm install @cubbit/enigmaIf you want to work from source, just clone the repo and run the install script as:
git clone https://github.com/cubbit/enigma.git
cd enigma
npm installBefore installing, download and install Node.js. Node.js version 8.0 or higher is required (Node.js 11 has not been tested yet).
Enigma is supported on the following platforms.
| x86 | x64 | arm32 | arm64 | |
|---|---|---|---|---|
| Linux | ︎︎︎ ✔︎ | ✔︎ | ✔︎ | ✔︎ |
| macOS | - | ✔︎ | - | ✔︎ |
| Windows | ✔︎ | ✔︎ | - | - |
After installing just import @cubbit/enigma in your code and you are ready to go.
Install the library by following the Installation section. Then, just import @cubbit/enigma in your source and use it as you would do on Node.js.
Important: Enigma needs a Buffer polyfill in order to work correctly on the web. The default one provided by webpack is ok. Otherwise you'll need to provide one by yourself.
Enigma includes the following cryptographical utilities:
- Hashing algorithms (SHA256)
- Simmetric encryption algorithms (AES256)
- Asymmetric encryption algorithms (RSA, ECC)
- Misc utilities (DiffieHellman key exchange, Random, Key derivation algorithms)
Please refer to the API section to discover more about how to use each of them
importEnigmafrom'@cubbit/enigma';constmessage='Hello world';consthash=Enigma.Hash.digest(message);console.log(hash);// A591A6D40BF420404A011733CFB7B190D62C65BF0BCDA32B57B277D9AD9F146EimportEnigmafrom'@cubbit/enigma';newEnigma.AES().init().then(async(aes: Enigma.AES)=>{constmy_secret='My secret';constcipher=awaitaes.encrypt(my_secret);console.log(cipher);});/*{ content: <Buffer 16 6e b6 61 1b e0 d9 3a 25>, tag: <Buffer 07 cf 9d 9c 53 6a 13 5f 5f 24 75 a3 64 1f bd 89>, iv: <Buffer 62 d6 9b 8c bc 23 3c e5 9b 77 30 2e 56 cc f9 35>}*/When encrypting a big file you may encounter browser limitations or memory issues. The AES stream class is design to overcome these problems.
// On Node.jsimport{createReadStream}from'fs';importEnigmafrom'@cubbit/enigma';constfile_stream=fs.createReadStream('my_secret_image.png');newEnigma.AES().init().then((aes: Enigma.AES)=>{constiv=Enigma.Random.bytes(16);constaes_stream=aes.encrypt_stream(iv);aes_stream.once('finish',()=>console.log('File encrypted'));file_stream.pipe(aes_stream);});// On the WebimportEnigmafrom'@cubbit/enigma';importWebFileStreamfrom'@cubbit/web-file-stream';constfile=newFile();// You can get this File object through an file input tagconstfile_stream=WebFileStream.create_read_stream(file);newEnigma.AES().init().then((aes: Enigma.AES)=>{constiv=Enigma.Random.bytes(16);constaes_stream=aes.encrypt_stream(iv);aes_stream.once('finish',()=>console.log('File encrypted'));file_stream.pipe(aes_stream);});importEnigmafrom'@cubbit/enigma';constexisting_key=/*...*/constaes=newEnigma.AES().init({key: existing_key}).then(async(aes: Enigma.AES=>{constmessage=aes.decrypt(my_secret).toString();console.log(message);// "My secret"});importEnigmafrom'@cubbit/enigma';constkeypair=Enigma.RSA.create_keypair();importEnigmafrom'@cubbit/enigma';constmessage='My secret';newEnigma.RSA().init().then(async(rsa: Enigma.RSA)=>{constencrypted=awaitEnigma.RSA.encrypt(message,rsa.keypair.public_key);console.log(encrypted);/* <Buffer 7c 01 29 9e 8e 8a 5c a0 ad 28 5a 19 b4 97 43 96 ca 49 0f 73 f9 bf 4d 27 7a 01 c7 d8 11 b5 8f c4 1e 69 c1 cc ef a2 74 03 8f 04 bc 0e 3d c2 4d 89 c4 10 ... > */constdecrypted=(awaitrsa.decrypt(encrypted)).toString();console.log(decrypted);// "My secret"});importEnigmafrom'@cubbit/enigma';constkeypair=Enigma.ED25519.create_keypair();importEnigmafrom'@cubbit/enigma';constmessage='To be signed';constecc=newEnigma.ED25519();constsignature=ecc.sign(message);Enigma.ED25519.verify(message,ecc.keypair.public_key,signature).then(console.log)// trueimportEnigmafrom'@cubbit/enigma';constmessage='Original message';constsalted_key=awaitEnigma.KeyDerivation.pbkdf2(message);importEnigmafrom'@cubbit/enigma';constobject={message: 'To be signed'};constecc=newEnigma.ED25519();constcontract=Enigma.Attorney.redact(object,ecc);constis_valid=Enigma.Attorney.verify(contract,ecc.keypair.public_key);console.log(is_valid);// trueimportEnigmafrom'@cubbit/enigma';Enigma.init().then(async()=>{constrandom_int4=Enigma.Random.integer(32);constrandom_bytes=Enigma.Random.bytes(32);});A class which permits a DiffieHellman key echange based on elliptic curves. Elliptic curve adopted is NID_X9_62_prime256v1.
initialize(): void: generate the key pairs.get_public_key(): string: returns the public key as a string having these properties: PEM format; uncompressed; ASN.1 standard form called NAMED CURVE.derive_secret(endpoint_public_key: string): string: needs a public key in the same format described above and returns the secret as a string in hex format.
importEnigmafrom'@cubbit/enigma';Enigma.init().then(async()=>{constdh=newEnigma.DiffieHellman();dh.initialize();constpublic_key: string=dh.get_public_key();// receive public key from remote endpoint// send my public key to remote endpointconstshared_secret: string=awaitdh.derive_secret(endpoint_public_key);});To build the project's bindings just run the following command after cloning the repository:
npm run build
npm run build:webTo run the test suite, first install the dependencies, then run npm test:
npm install
npm testFeel free to open an issue or a pull request to report bugs and suggest new features. Please refer to our Contributions guidelines for more details about the contribution process.