feat(bkgpslog):Implement compression and encryption
authorSteven Baltakatei Sandoval <baltakatei@gmail.com>
Mon, 29 Jun 2020 20:30:50 +0000 (20:30 +0000)
committerSteven Baltakatei Sandoval <baltakatei@gmail.com>
Mon, 29 Jun 2020 20:30:50 +0000 (20:30 +0000)
Add compression option.

Implement compression of output files.

Implement encryption of output files.

exec/bkgpslog

index 21c5fc08435c2549dbb68e9632c54331e2fe0e56..f7d1b187e7951736051281191349124803e57898 100755 (executable)
@@ -151,8 +151,11 @@ showUsage() {
     echoerr "    -o, --output [ directory ]"
     echoerr "            Specify output directory to save logs."
     echoerr
     echoerr "    -o, --output [ directory ]"
     echoerr "            Specify output directory to save logs."
     echoerr
+    echoerr "    -c, --compress"
+    echoerr "            Compress output with gzip (before encryption if enabled)."
+    echoerr
     echoerr "EXAMPLE: (bash script lines)"
     echoerr "EXAMPLE: (bash script lines)"
-    echoerr "/bin/bash bkgpslog -e \\"
+    echoerr "/bin/bash bkgpslog -e -c \\"
     echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"
     echoerr "-r age1ala848kqrvxc88rzaauc6vc5v0fqrvef9dxyk79m0vjea3hagclswu0lgq \\"
     echoerr "-o ~/Sync/Location"
     echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"
     echoerr "-r age1ala848kqrvxc88rzaauc6vc5v0fqrvef9dxyk79m0vjea3hagclswu0lgq \\"
     echoerr "-o ~/Sync/Location"
@@ -194,6 +197,7 @@ processArguments() {
            -e | --encrypt) OPTION_ENCRYPT="true"; vbm "DEBUG:Encrypted output mode enabled.";;
            -r | --recipient) # Add 'age' recipient via public key string
                recPubKeys+=("$2"); vbm "pubkey added:""$2"; shift;;
            -e | --encrypt) OPTION_ENCRYPT="true"; vbm "DEBUG:Encrypted output mode enabled.";;
            -r | --recipient) # Add 'age' recipient via public key string
                recPubKeys+=("$2"); vbm "pubkey added:""$2"; shift;;
+           -c | --compress) OPTION_COMPRESS="true"; vbm "DEBUG:Compressed output mode enabled.";;
            *) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
        esac
        shift
            *) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
        esac
        shift
@@ -276,20 +280,40 @@ main() {
        if checkapp age; then # Check that age is available.
            for pubkey in "${recPubKeys[@]}"; do # Validate recipient pubkey strings by forming test message
                vbm "DEBUG:Testing pubkey string:$pubkey"
        if checkapp age; then # Check that age is available.
            for pubkey in "${recPubKeys[@]}"; do # Validate recipient pubkey strings by forming test message
                vbm "DEBUG:Testing pubkey string:$pubkey"
-               if ! echo "butts" | age -a -r "$pubkey" 1>/dev/null; then
-                   yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1;
-               else
+               if echo "butts" | age -a -r "$pubkey" 1>/dev/null; then
                    # Form age recipient string
                    recipients="$recipients""-r $pubkey ";
                    # Form age recipient string
                    recipients="$recipients""-r $pubkey ";
-                   vbm "Added pubkey:""$pubkey";
+                   vbm "Added pubkey for forming age recipient string:""$pubkey";
                    vbm "DEBUG:recipients:""$recipients";
                    vbm "DEBUG:recipients:""$recipients";
+               else
+                   yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1;
                fi
            done
            vbm "DEBUG:Finished processing recPubKeys array";
                fi
            done
            vbm "DEBUG:Finished processing recPubKeys array";
+           # Form age command string
+           CMD_ENCRYPT=" | age ""$recipients ";
+           CMD_ENCRYPT_SUFFIX=".age";
        else
            yell "ERROR:Encryption enabled but \"age\" not found. Exiting."; exit 1;
        fi
        else
            yell "ERROR:Encryption enabled but \"age\" not found. Exiting."; exit 1;
        fi
+    else
+       CMD_ENCRYPT="";
+       CMD_ENCRYPT_SUFFIX="";
+       vbm "DEBUG:Encryption not enabled."
     fi
     fi
+
+    if [[ "$OPTION_COMPRESS" = "true" ]]; then # Check if compression option active
+       if checkapp gzip; then # Check if gzip available
+           CMD_COMPRESS=" | gzip ";
+           CMD_COMPRESS_SUFFIX=".gz";
+       else
+           yell "ERROR:Compression enabled but \"gzip\" not found. Exiting."; exit 1;
+    else
+       CMD_COMPRESS="";
+       CMD_COMPRESS_SUFFIX="";
+       vbm "DEBUG:Compression not enabled."
+    fi
+    
     
     if checkapp gpspipe && checkdir "$DIROUT"; then
        
     
     if checkapp gpspipe && checkdir "$DIROUT"; then
        
@@ -320,15 +344,15 @@ main() {
            ((debugCounter++))
            # Determine output file paths (time is start of buffer period)
            FILEOUT_BASENAME="$(dateTimeShort)""--P""$bufferTTL""S..""$SCRIPT_HOSTNAME""_location" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
            ((debugCounter++))
            # Determine output file paths (time is start of buffer period)
            FILEOUT_BASENAME="$(dateTimeShort)""--P""$bufferTTL""S..""$SCRIPT_HOSTNAME""_location" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
-           FILEOUT_NMEA="$FILEOUT_BASENAME".nmea ;
-           FILEOUT_GPX="$FILEOUT_BASENAME".gpx ;
-           FILEOUT_KML="$FILEOUT_BASENAME".kml ;
+           FILEOUT_NMEA="$FILEOUT_BASENAME".nmea"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
+           FILEOUT_GPX="$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
+           FILEOUT_KML="$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
            # Fill buffer
            buffer="$(timeout "$bufferTTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds
            # Process and save buffers
            # Fill buffer
            buffer="$(timeout "$bufferTTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds
            # Process and save buffers
-           echo "$buffer"                                     > "$DIROUT"/"$FILEOUT_NMEA" & # Save NMEA format
-           echo "$buffer" | gpsbabel -i nmea -f - -o gpx -F - > "$DIROUT"/"$FILEOUT_GPX"  & # Save GPX format
-           echo "$buffer" | gpsbabel -i nmea -f - -o kml -F - > "$DIROUT"/"$FILEOUT_KML"  & # Save KML format
+           echo "$buffer"                                     "$CMD_COMPRESS" "$CMD_ENCRYPT" > "$DIROUT"/"$FILEOUT_NMEA" & # Save NMEA format
+           echo "$buffer" | gpsbabel -i nmea -f - -o gpx -F - "$CMD_COMPRESS" "$CMD_ENCRYPT" > "$DIROUT"/"$FILEOUT_GPX" & # Save GPX format
+           echo "$buffer" | gpsbabel -i nmea -f - -o kml -F - "$CMD_COMPRESS" "$CMD_ENCRYPT" > "$DIROUT"/"$FILEOUT_KML" & # Save KML format
            vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
            # Reset buffer and filenames
            unset buffer FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;
            vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
            # Reset buffer and filenames
            unset buffer FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;