octosecret-crypto
Encrypt and decrypt data using RSA keys
What
Nodejs library that wraps openSSL to provide encryption and decryption of files and buffers. This was originally created to provide the crypto layer of octosecret, a CLI that allows easy data encryption and decryption between github users.
Features
- Encrypt and decrypt files
- Encrypt and decrypt streams (eg: text, buffer..)
- Encryption support multiple keys
Install
npm install octosecret-crypto --save
API
File operations:
- file.encrypt(origin, destination, keys)
- file.decrypt(origin, destination, [key])
Stream operations:
- stream.encrypt(data, keys)
- stream.decrypt(data, [key])
Utils:
- util.randomSymmetricKey(bytes)
- util.createEncryptionKey(keys)
- util.rsa2pkcs8(origin, destination)
- util.rsaEncrypt(data, pkcs8_file)
- util.rsaDecrypt(data, privateKey)
- util.base64Encode(data)
- util.base64Decode(data)
- util.fileEncrypt(origin, destination, key)
- util.fileDecrypt(origin, destination, key)
- util.bufferEncrypt(buffer, key)
- util.bufferDecrypt(buffer, key)
Examples
Encrypt and decrypt files
const octosecret = // Encrypt "octocat.gif" to "octocat.gif.octosecret" using "public.key"await octosecretfile // Decrypt "octocat.gif.octosecret" to "octocat.gif" using "id_rsa" keyawait octosecretfile
Encrypt and decrypt streams
const octosecret = // Example dataconst dataToEncrypt = "Super secret message" // Encryptconst encrypted = await octosecretstream // Decryptconst decrypted = await octosecretstream // Convert Buffer to Stringconst decryptedText = decrypted// "Super secret message"
Check __test__
and src/example.js
for more examples
License
MIT © Hugo Rodrigues