@sequencemedia/crypto 1.1.2 → 1.1.4

package/README.md

@@ -0,0 +1,102 @@
+# @sequencemedia/crypto
+
+Encrypt and decrypt in Node and Bash
+
+## Node
+
+Exports two functions, `encrypt` and `decrypt`
+
+```javascript
+import {
+  encrypt,
+  decrypt
+} from '@sequencemedia/crypto'
+```
+
+### `encrypt`
+
+```typescript
+function encrypt(buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
+```
+
+Only `buffer` and `secret` are _required_
+
+- `buffer` is the data to encrypt
+- `secret` is the secret key to use for encryption
+
+Both `bytes` and `algorithm` are _optional_
+
+- `bytes` is the number of random bytes to use for the encryption _initialisation vector_. The default is `16`
+- `algorithm` is the algorithm to use for encryption. The default is `aes-256-ctr`
+
+### `decrypt`
+
+```typescript
+function decrypt(buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
+```
+
+Only `buffer` and `secret` are _required_
+
+- `buffer` is the data to decrypt
+- `secret` is the secret key to use for decryption
+
+Both `bytes` and `algorithm` are _optional_
+
+- `bytes` is the number of bytes to slice from the buffer for the decryption _initialisation vector_. The default is `16`
+- `algorithm` is the algorithm to use for decryption. The default is `aes-256-ctr`
+
+## Bash
+
+Exports two functions, `encrypt` and `decrypt`
+
+```bash
+source ./crypto.sh
+```
+
+### `encrypt`
+
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment and a file path to _encrypt_
+
+```bash
+encrypted_file_data=$(encrypt "./file.txt")
+```
+
+```bash
+encrypt "./file.txt" > "./encrypted.txt"
+```
+
+### `decrypt`
+
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment and a file path to _decrypt_
+
+```bash
+file_data=$(decrypt "./encrypted.txt")
+```
+
+```bash
+decrypt "./encrypted.txt" > "./file.txt"
+```
+
+## Bash utilities
+
+### `encrypt.sh`
+
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment
+
+- A file _origin_ path for data to _encrypt_
+- A file _destination_ path to put the encrypted data
+
+```bash
+CRYPTO_KEY='secret' ./encrypt.sh --origin "./file.txt" --destination "./encrypted.txt"
+```
+
+### `decrypt.sh`
+
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment
+
+- A file _origin_ path for data to _decrypt_
+- A file _destination_ path to put the decrypted data
+
+```bash
+CRYPTO_KEY='secret' ./decrypt.sh --origin "./encrypted.txt" --destination "./file.txt"
+```

package/crypto.d.ts

@@ -1,5 +1,5 @@
 declare module '@sequencemedia/crypto' {
-  export function hashKey(key: string): string
-  export function encode(buffer: Buffer, key: string, secret?: string): Buffer
-  export function decode(buffer: Buffer, key: string, secret?: string): Buffer
+  export function hashKey(secret: string): string
+  export function encrypt(buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
+  export function decrypt(buffer: Buffer, secret: string, bytes?: number, algorithm?: string): Buffer
 }

package/crypto.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+encrypt () {
+  node ./src/shell/encrypt.mjs < "$1"
+}
+
+decrypt () {
+  node ./src/shell/decrypt.mjs < "$1"
+}
+
+get_args () {
+  for flag in "$@";
+  do
+    shift
+    case "$flag" in
+      '--origin')
+        set -- "$@" '-o'
+        ;;
+      '--destination')
+        set -- "$@" '-d'
+        ;;
+      *)
+        set -- "$@" "$flag"
+        ;;
+    esac
+  done
+
+  while getopts ":o:d:" flag;
+  do
+    case "${flag}" in
+      o)
+        export ORIGIN=$OPTARG
+        ;;
+      d)
+        export DESTINATION=$OPTARG
+        ;;
+    esac
+  done
+}
+
+export -f encrypt
+
+export -f decrypt

package/decrypt.sh

@@ -1,7 +1,20 @@
 #!/bin/bash
 
-decrypt () {
-  node ./src/shell/decrypt.mjs < "$1"
-}
+source ./crypto.sh
 
-export -f decrypt
+get_args "$@";
+
+if [[ -z "$ORIGIN" ]];
+then
+  echo Origin is required
+  exit 1
+fi
+
+if [[ -z "$DESTINATION" ]];
+then
+  echo Destination is required
+  exit 1
+fi
+
+decrypt "$ORIGIN" > "$DESTINATION"
+exit 0

package/encrypt.sh

@@ -1,7 +1,20 @@
 #!/bin/bash
 
-encrypt () {
-  node ./src/shell/encrypt.mjs < "$1"
-}
+source ./crypto.sh
 
-export -f encrypt
+get_args "$@";
+
+if [[ -z "$ORIGIN" ]];
+then
+  echo Origin is required
+  exit 1
+fi
+
+if [[ -z "$DESTINATION" ]];
+then
+  echo Destination is required
+  exit 1
+fi
+
+encrypt "$ORIGIN" > "$DESTINATION"
+exit 0

package/lib/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.decrypt=decrypt;exports.encrypt=encrypt;exports.hashKey=hashKey;var _crypto=_interopRequireDefault(require("crypto"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj};}function hashKey(key){if(!key)throw new Error('A key is required');return _crypto.default.createHash('sha256').update(key).digest('base64').substring(0,32);}function encrypt(buffer,key,bytes=16,algorithm='aes-256-ctr'){const iv=_crypto.default.randomBytes(bytes);const cipher=_crypto.default.createCipheriv(algorithm,hashKey(key),iv);return Buffer.concat([iv,cipher.update(buffer),cipher.final()]);}function decrypt(buffer,key,bytes=16,algorithm='aes-256-ctr'){const iv=buffer.slice(0,bytes);const decipher=_crypto.default.createDecipheriv(algorithm,hashKey(key),iv);return Buffer.concat([decipher.update(buffer.slice(bytes)),decipher.final()]);}
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.decrypt=decrypt;exports.encrypt=encrypt;exports.hashKey=hashKey;var _crypto=_interopRequireDefault(require("crypto"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj};}function hashKey(secret){if(!secret)throw new Error('A secret is required');return _crypto.default.createHash('sha256').update(secret).digest('base64').substring(0,32);}function encrypt(buffer,secret,bytes=16,algorithm='aes-256-ctr'){const iv=_crypto.default.randomBytes(bytes);const cipher=_crypto.default.createCipheriv(algorithm,hashKey(secret),iv);return Buffer.concat([iv,cipher.update(buffer),cipher.final()]);}function decrypt(buffer,secret,bytes=16,algorithm='aes-256-ctr'){const iv=buffer.slice(0,bytes);const decipher=_crypto.default.createDecipheriv(algorithm,hashKey(secret),iv);return Buffer.concat([decipher.update(buffer.slice(bytes)),decipher.final()]);}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/crypto",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "main": "./lib/index.cjs",
   "type": "module",
   "types": "./crypto.d.ts",

package/src/index.mjs

@@ -1,19 +1,19 @@
 import crypto from 'crypto'
 
-export function hashKey (key) {
-  if (!key) throw new Error('A key is required')
+export function hashKey (secret) {
+  if (!secret) throw new Error('A secret is required')
 
-  return crypto.createHash('sha256').update(key).digest('base64').substring(0, 32)
+  return crypto.createHash('sha256').update(secret).digest('base64').substring(0, 32)
 }
 
-export function encrypt (buffer, key, bytes = 16, algorithm = 'aes-256-ctr') {
+export function encrypt (buffer, secret, bytes = 16, algorithm = 'aes-256-ctr') {
   const iv = crypto.randomBytes(bytes)
-  const cipher = crypto.createCipheriv(algorithm, hashKey(key), iv)
+  const cipher = crypto.createCipheriv(algorithm, hashKey(secret), iv)
   return Buffer.concat([iv, cipher.update(buffer), cipher.final()])
 }
 
-export function decrypt (buffer, key, bytes = 16, algorithm = 'aes-256-ctr') {
+export function decrypt (buffer, secret, bytes = 16, algorithm = 'aes-256-ctr') {
   const iv = buffer.slice(0, bytes)
-  const decipher = crypto.createDecipheriv(algorithm, hashKey(key), iv)
+  const decipher = crypto.createDecipheriv(algorithm, hashKey(secret), iv)
   return Buffer.concat([decipher.update(buffer.slice(bytes)), decipher.final()])
 }