@sequencemedia/crypto 1.1.16 → 1.1.18

package/README.md

@@ -4,7 +4,7 @@ Encrypt and decrypt in Node and Bash
 
 ## Node
 
-Exports two functions, `encrypt` and `decrypt`
+The package _main_ exports two functions, `encrypt` and `decrypt`
 
 ```javascript
 import {
@@ -57,13 +57,28 @@ Both `bytes` and `algorithm` are _optional_
 
 ## Bash
 
-Exports two functions, `encrypt` and `decrypt`
+The package contains three scripts
+
+1. `crypto.sh`
+1. `encrypt.sh`
+2. `decrypt.sh`
+
+Script `crypto.sh` exports four functions to consume in your own Bash scripts
 
 ```bash
 source ./crypto.sh
 ```
 
-### `encrypt`
+1. `encrypt`
+2. `decrypt`
+3. `encrypt_directory`
+4. `decrypt_directory`
+
+Scripts [`encrypt.sh`](#encryptsh) and [`decrypt.sh`](#decryptsh) can be executed at the command line
+
+### Bash functions
+
+#### `encrypt`
 
 Requires `CRYPTO_KEY` as a _variable_ in the Bash environment and a file path to _encrypt_
 
@@ -77,7 +92,7 @@ CRYPTO_KEY='secret'
 encrypt "./file.txt" > "./encrypted.txt"
 ```
 
-### `decrypt`
+#### `decrypt`
 
 Requires `CRYPTO_KEY` as a _variable_ in the Bash environment and a file path to _decrypt_
 
@@ -91,32 +106,86 @@ CRYPTO_KEY='secret'
 decrypt "./encrypted.txt" > "./file.txt"
 ```
 
-## Bash scripts
+#### `encrypt_directory`
 
-### `encrypt.sh`
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment and a directory path to _encrypt_
 
-Requires `CRYPTO_KEY` as a _variable_ in the Bash environment
+- The first argument is the origin directory of files to _encrypt_
+- The second argument is the destination directory for the _encrypted_ files
 
-- A file _origin_ path for data to _encrypt_
-- A file _destination_ path to put the encrypted data
+```bash
+CRYPTO_KEY='secret'
+encrypt_directory "./directory" "./encrypted"
+```
+
+#### `decrypt_directory`
+
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment and a directory path to _decrypt_
+
+- The first argument is the origin directory of files to _decrypt_
+- The second argument is the destination directory for the _decrypted_ files
 
 ```bash
 CRYPTO_KEY='secret'
-./encrypt.sh \
+decrypt_directory "./encrypted" "./directory"
+```
+
+### Bash scripts
+
+#### `encrypt.sh`
+
+Requires `CRYPTO_KEY` as a _variable_ in the Bash environment
+
+- You can provide either _file_ or _directory_ paths
+- You can provide `--verbose` or `-v`
+
+##### File paths
+
+- A file _origin_ path to _encrypt_
+- A file _destination_ path for the _encrypted_ file
+
+```bash
+CRYPTO_KEY='secret' ./encrypt.sh \
   --origin "./file.txt" \
   --destination "./encrypted.txt"
 ```
 
-### `decrypt.sh`
+##### Directory paths
+
+- A directory _origin_ path to _encrypt_
+- A directory _destination_ path for _encrypted_ files
+
+```bash
+CRYPTO_KEY='secret' ./encrypt.sh \
+  --origin "./directory" \
+  --destination "./encrypted"
+```
+
+#### `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
+- You can provide either _file_ or _directory_ paths
+- You can provide `--verbose` or `-v`
+
+##### File paths
+
+- A file _origin_ path to _decrypt_
+- A file _destination_ path for the _decrypted_ file
 
 ```bash
-CRYPTO_KEY='secret'
-./decrypt.sh \
+CRYPTO_KEY='secret' ./decrypt.sh \
   --origin "./encrypted.txt" \
   --destination "./file.txt"
 ```
+
+##### Directory paths
+
+- A directory _origin_ path to _decrypt_
+- A directory _destination_ path for _decrypted_ files
+
+```bash
+CRYPTO_KEY='secret' ./decrypt.sh \
+  --origin "./encrypted" \
+  --destination "./directory"
+```

package/crypto.sh

@@ -1,12 +1,6 @@
 #!/bin/bash
 
-encrypt () {
-  node ./src/shell/encrypt.mjs < "$1"
-}
-
-decrypt () {
-  node ./src/shell/decrypt.mjs < "$1"
-}
+VERBOSE=false
 
 get_args () {
   for flag in "$@";
@@ -19,13 +13,16 @@ get_args () {
       '--destination')
         set -- "$@" '-d'
         ;;
+      '--verbose')
+        set -- "$@" '-v'
+        ;;
       *)
         set -- "$@" "$flag"
         ;;
     esac
   done
 
-  while getopts ":o:d:" flag;
+  while getopts ":o:d:v" flag;
   do
     case "${flag}" in
       o)
@@ -34,10 +31,138 @@ get_args () {
       d)
         export DESTINATION=$OPTARG
         ;;
+      v)
+        VERBOSE=true
+        ;;
+      *)
+        echo Ignoring "$flag"
+        ;;
     esac
   done
 }
 
+get_path () {
+  local absolute_path
+
+  case "${1}" in
+    [./]*)
+      absolute_path="$(cd "${1%/*}" || exit; pwd)/${1##*/}"
+      ;;
+    *)
+      absolute_path="${!PWD}/${1}"
+      ;;
+  esac
+
+  # shellcheck disable=SC2001
+  echo "$(sed "s,/$,," <<< "$absolute_path")"
+}
+
+encrypt () {
+  node ./src/shell/encrypt.mjs < "$1"
+}
+
+decrypt () {
+  node ./src/shell/decrypt.mjs < "$1"
+}
+
+encrypt_directory () {
+  local current_directory
+  local destination_directory
+  local directory_root
+
+  current_directory=$(get_path "$1")
+  destination_directory=$(get_path "$2")
+  directory_root=$(get_path "${3-$1}")
+
+  for child in "$current_directory"/*;
+  do
+    # Recurse $child directory
+    if [ -d "$child" ];
+    then
+      local file_path
+
+      [[ "$child" =~ "$directory_root"/(.*)$ ]] && file_path="${BASH_REMATCH[1]}"
+
+      mkdir -p "$destination_directory/$file_path"
+
+      local directory="$child"
+
+      [[ $VERBOSE == true ]] && echo Recursing into "$directory"
+
+      encrypt_directory "$directory" "$destination_directory" "$directory_root"
+    else
+      # Ensure $child is a file (not "/*")
+      if [ -f "$child" ];
+      then
+        local file_name
+
+        [[ "$child" =~ "$directory_root"/(.*) ]] && file_name="${BASH_REMATCH[1]}"
+
+        mkdir -p "$destination_directory"
+
+        local file="$child"
+
+        [[ $VERBOSE == true  ]] && echo Encrypting "$file"
+
+        encrypt "$file" > "$destination_directory/$file_name"
+      fi
+    fi
+  done
+}
+
+decrypt_directory () {
+  local current_directory
+  local destination_directory
+  local directory_root
+
+  current_directory=$(get_path "$1")
+  destination_directory=$(get_path "$2")
+  directory_root=$(get_path "${3-$1}")
+
+  for child in "$current_directory"/*;
+  do
+    # Recurse $child directory
+    if [ -d "$child" ];
+    then
+      local file_path
+
+      [[ "$child" =~ "$directory_root"/(.*)$ ]] && file_path="${BASH_REMATCH[1]}"
+
+      mkdir -p "$destination_directory/$file_path"
+
+      local directory
+
+      directory="$child"
+
+      [[ $VERBOSE == true ]] && echo Recursing into "$directory"
+
+      decrypt_directory "$directory" "$destination_directory" "$directory_root"
+    else
+      # Ensure $child is a file (not "/*")
+      if [ -f "$child" ];
+      then
+        local file_name
+
+        [[ "$child" =~ "$directory_root"/(.*) ]] && file_name="${BASH_REMATCH[1]}"
+
+        mkdir -p "$destination_directory"
+
+        local file
+
+        file="$child"
+
+        [[ $VERBOSE == true ]] && echo Decrypting "$file"
+
+        decrypt "$file" > "$destination_directory/$file_name"
+      fi
+    fi
+  done
+}
+
 export -f encrypt
 
 export -f decrypt
+
+export -f encrypt_directory
+
+export -f decrypt_directory

package/decrypt.sh

@@ -16,5 +16,17 @@ then
   exit 1
 fi
 
+if [ -d "$ORIGIN" ];
+then
+  if [ -d "$DESTINATION" ];
+  then
+    decrypt_directory "$ORIGIN" "$DESTINATION"
+    exit 0
+  else
+    echo Origin is a directory but destination is not a directory
+    exit 1
+  fi
+fi
+
 decrypt "$ORIGIN" > "$DESTINATION"
 exit 0

package/encrypt.sh

@@ -16,5 +16,17 @@ then
   exit 1
 fi
 
+if [ -d "$ORIGIN" ];
+  then
+  if [ -d "$DESTINATION" ];
+  then
+    encrypt_directory "$ORIGIN" "$DESTINATION"
+    exit 0
+  else
+    echo Origin is a directory but destination is not a directory
+    exit 1
+  fi
+fi
+
 encrypt "$ORIGIN" > "$DESTINATION"
 exit 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sequencemedia/crypto",
-  "version": "1.1.16",
+  "version": "1.1.18",
   "keywords": [
     "crypto",
     "node",
@@ -40,8 +40,8 @@
     "@babel/core": "^7.21.4",
     "@babel/eslint-parser": "^7.21.3",
     "@babel/preset-env": "^7.21.4",
-    "@sequencemedia/hooks": "^1.0.392",
-    "@types/node": "^18.15.12",
+    "@sequencemedia/hooks": "^1.0.393",
+    "@types/node": "^18.15.13",
     "core-js": "^3.30.1",
     "eslint": "^8.38.0",
     "eslint-config-standard": "^17.0.0",